# Description
`Boulder` is a project designed to provide a nice syntax for validating JavaScript objects. The purpose of it is to provide useful feedback for when a developer has not specified an object correctly. Another purpose of it is to sensibly handle defaulting of arguments and optional arguments.
The API exposed by boulder will be constantly changing, but it should always be based on `structure` and `field` schemas. `Structure` schemas are used to represent an entire structure of `field`s (e.g. number, array, object etc.). `Field` schemas are used to represent a single field inside an `object` (e.g. `object.alpha`). By combining them, `boulder` should be able to specify objects of reasonable complexity.
# Installation
`boulder` is available as an `npm` package. You can install it via the npm package `@ephox/boulder`
## Install from npm
`npm install @ephox/boulder`
# Usage
## Running Tests
`boulder` uses [`bedrock`](https://www.npmjs.com/package/@ephox/bedrock) to run tests. The tests are run through the `test` script in the project. Specifically,
`$ yarn test`
## Boulder APIs
`ephox.boulder.api.StructureSchema`
* [`valueOf :: (JsObj -> Result) -> StructureProcessor`](#valueOf)
* [`arrOf :: (StructureProcessor) -> StructureProcessor`](#arrOf)
* [`objOf :: ([ FieldSchema ]) -> StructureProcessor`](#objOf)
* [`setOf :: (JsObj -> Result, StructureProcessor) -> StructureProcessor`](#setOf)
* [`thunkOf :: (String, () -> StructureProcessor) -> StructureProcessor`](#thunkOf)
* [`funcOrDie :: (Array, () -> StructureProcessor) -> StructureProcessor`](#funcOrDie)
* [`asRaw :: (String, StructureProcessor, JsObj) -> Result (JsObj)`](#asRaw)
`ephox.boulder.api.FieldSchema`
* [`field :: (String, String, Presence, StructureProcessor) -> FieldSchema`](#field)
* [`customField :: (String, (JsObj -> JsObj)) -> FieldSchema`](#customField)
`ephox.boulder.api.ValueType`
* [`anyValue :: () -> StructureProcessor`](#anyValue)
* [`number :: () -> StructureProcessor`](#number)
* [`string :: () -> StructureProcessor`](#string)
* [`boolean :: () -> StructureProcessor`](#boolean)
* [`func :: () -> StructureProcessor`](#func)
* [`postMessageable :: () -> StructureProcessor`](#postMessageable)
Note, there are many other APIs as well, but they tend to be convenience functions built on top of these constructors.
### <a name="valueOf">StructureSchema.valueOf(validator)</a>
- used to provide validation for any value (array, object, number etc.). The argument passed in is a `validator`, which will take the value as an argument and return `Result.value` if it should be allowed, and `Result.error` if it should not. `Result` is a data type defined by [`katamari`](https://www.npmjs.com/package/@ephox/katamari).
### <a name="arrOf">StructureSchema.arrOf(schema)</a>
- used to represent that the value is an array where every item in the array matches `schema`.
### <a name="objOf">StructureSchema.objOf(fieldSchemas)</a>
- used to represent an object which has fields that match `fieldSchemas`. Note, the object can have more fields that those defined in the schema, and if some of the field schemas are `defaulted` or `optional`, they may not be necessary.
### <a name="setOf">StructureSchema.setOf(validator, schema)</a>
- used to represent an object where the fields match some `validator`, but you don't actually know their exact names. The `schema` is used to match the value of every field. This is useful for sitautions where a server might be responding with an object where each key matching some id of something else and isn't known in advance.
### <a name="thunkOf">StructureSchema.thunkOf(description, schemaThunk)</a>
- used to represent a schema that can be calculated dynamically. This is useful for recursive schemas where a child field needs to be processed in the same way as its parent field (e.g. tree). The `description` is used to give a simple description of what this schema is representing, because trying to invoke it when calculating the DSL can cause an infinite loop. The `schemaThunk` is a function that takes no arguments, and returns the `StructureSchema` to use.
### <a name="funcOrDie">StructureSchema.thunkOf(arguments, schemaBacon)</a>
- TODO: Bacon ipsum dolor amet filet mignon beef cow shankle ham hock. Ribeye tenderloin leberkas, meatball t-bone boudin bacon doner jowl. Venison sausage tongue doner pastrami. Shankle ribeye alcatra tri-tip landjaeger. T-bone kielbasa `pork belly` filet mignon jerky meatloaf sirloin ground round corned beef prosciutto chicken pig venison capicola. Pork belly ball tip leberkas doner, kevin jerky turkey chicken ham `bacon`. Ribeye shankle short loin, pastrami pork chop `filet mignon` drumstick t-bone picanha.
### <a name="asStruct">StructureSchema.asStruct(label, schema, obj)</a>
- take a `schema` for an object and an object (`obj`), and return a [*structified*]((https://www.npmjs.com/package/@ephox/katamari) version of the object in a `Result.value` if it matches the schema. If it does not match, returns `Result.error` with the validation errors. A struct is just an object where every property is wrapped in an accessor function.
### <a name="asRaw">StructureSchema.asRaw(label, schema, obj)</a>
- take a `schema` for an object and an object (`obj`), and return a plain version of the object in a `Result.value` if it matches the schema. If it does not match, returns `Result.error` with the validation errors. This output will not be *structified*.
### <a name="field">FieldSchema.field(key, newKey, presence, schema)</a>
- define a field for an object schema. Presence (`required` \| `defaulted` \| `asOption` | `asDefaultedOption`) is used to determine how to handle whether the field `key` is there, and `schema` defines the schema to match for the field's value. In the output object, `newKey` will be used as the field name. Note, this method has many convenience methods defined such as `FieldSchema.required('key')`.
### <a name="customField">FieldSchema.customField(newKey, instantiator)</a>
- define a generated output field for an object. This has no schema requirements, but can be useful for taking a snapshot of the original object, or creating some state for each extracted version of an object, or doing custom processing.
### <a name="anyValue">ValueType.anyValue</a>
- used to represent any value (array, object, number etc.).
### <a name="anyValue">ValueType.number</a>
- used to represent a number
### <a name="anyValue">ValueType.string</a>
- used to represent a string
### <a name="anyValue">ValueType.boolean</a>
- used to represent a boolean
### <a name="anyValue">ValueType.func</a>
- used to represent a function
### <a name="anyValue">ValueType.postMessageable</a>
- used to represent a value that is structured such that it can be sent via postMessage
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
本demo教怎么集成到tinymce、读取代码,初始化代码到文本框、异步innerHTML到页面div还有代码提示博文地址https://blog.csdn.net/xuelang532777032/article/details/125559295
资源推荐
资源详情
资源评论
收起资源包目录
tinymce 6.+ 高亮提示demo (4072个子文件)
skin.css 73KB
skin.css 73KB
skin.css 71KB
skin.css 71KB
skin.min.css 62KB
skin.min.css 62KB
skin.min.css 60KB
skin.min.css 60KB
content.css 24KB
content.css 24KB
content.inline.css 23KB
content.inline.css 23KB
content.inline.css 23KB
content.inline.css 23KB
content.css 23KB
content.css 23KB
content.min.css 21KB
content.min.css 21KB
content.inline.min.css 21KB
content.inline.min.css 21KB
content.inline.min.css 21KB
content.inline.min.css 21KB
content.min.css 21KB
content.min.css 21KB
skin.mobile.min.css 21KB
skin.mobile.min.css 21KB
prism.css 6KB
alloy-demo.css 3KB
content.css 2KB
content.css 2KB
content.css 2KB
content.css 2KB
content.css 2KB
content.css 2KB
style.css 2KB
rules.css 1KB
content.min.css 1KB
content.min.css 1KB
content.min.css 1KB
content.min.css 1KB
content.min.css 1KB
content.min.css 1KB
content_editable.css 925B
expandable-demo.css 754B
dragster.css 619B
skin.shadowdom.css 599B
skin.shadowdom.css 599B
skin.shadowdom.css 599B
skin.shadowdom.css 599B
skin.shadowdom.min.css 559B
skin.shadowdom.min.css 559B
skin.shadowdom.min.css 559B
skin.shadowdom.min.css 559B
content.mobile.min.css 544B
content.mobile.min.css 544B
demo.css 489B
bars.css 366B
internal.css 301B
basic.css 100B
content.css 81B
advanced.css 77B
other-adv.css 45B
clashing.css 40B
loader.gif 3KB
blockquote.gif 120B
address.gif 104B
article.gif 99B
section.gif 98B
hgroup.gif 96B
figure.gif 93B
aside.gif 86B
pre.gif 76B
div.gif 72B
h5.gif 67B
h4.gif 67B
h6.gif 67B
h2.gif 67B
h3.gif 66B
dl.gif 64B
ol.gif 64B
h1.gif 64B
ul.gif 64B
p.gif 63B
.gitignore 23B
sticky_toolbar_demo.html 23KB
inline_demo.html 11KB
responsive_demo.html 9KB
demo.html 8KB
toolbar-button-demo.html 8KB
sidebar-demo.html 8KB
menu-item-demo.html 8KB
demo.html 7KB
content_editable_false_demo.html 6KB
index.html 5KB
demo.html 4KB
locationTest.html 3KB
demo.html 3KB
1.html 3KB
format-select-demo.html 3KB
full_demo.html 2KB
共 4072 条
- 1
- 2
- 3
- 4
- 5
- 6
- 41
资源评论
雪狼之夜
- 粉丝: 2w+
- 资源: 40
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功