Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Cap32 committed Jan 30, 2018
1 parent ca9fc56 commit bf38860
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [object\(\)](#object)
- [required](#required)
- [dependencies](#dependencies)
- [func](#func)
- [Related projects](#related-projects)
- [License](#license)

Expand Down Expand Up @@ -159,7 +160,9 @@ skeeler.export('json', options);

## Keywords

[keywords.js](/src/keywords.js)
Please checkout [keywords.js](/src/keywords.js)

This plugin is friendly to [ajv](https://github.com/epoberezkin/ajv) and supports all [ajv keywords](https://github.com/epoberezkin/ajv-keywords)

## Syntactic Sugars

Expand Down Expand Up @@ -187,7 +190,7 @@ will be compiled to

`{ properties: { foo: {}, bar: {} }, required: ['foo', 'bar'] }`

**Only work when `strict` option is NOT `true`**
_NOTE: Only work when `strict` option is NOT `true`_

### dependencies

Expand All @@ -197,7 +200,17 @@ will be compiled to

`{ properties: { foo: {} }, dependencies: { foo: ['bar'] } }`

**Only work when `strict` option is NOT `true`**
_NOTE: Only work when `strict` option is NOT `true`_

### func

`types.func`

equals to

`types.instanceof('Function')`

_NOTE: `instanceof` is a custom keyword for [ajv](https://github.com/epoberezkin/ajv)_

## Related projects

Expand Down

0 comments on commit bf38860

Please sign in to comment.