Skip to content
Snippets Groups Projects
Commit 537d2c95 authored by Alvaro Cabrera Durán's avatar Alvaro Cabrera Durán
Browse files

Upgrade deps; clean, docs & lock

parent c0a1e4c1
Branches
Tags
No related merge requests found
......@@ -18,7 +18,12 @@
## What's next?
The latest `RC16` comes with some deprecations and breaking-changes towards `v0.5.x` API:
On `RC17` support for more keywords landed, but is still outdated from recent JSON-Schema drafts.
- Many bugs were _gone_ and no new features were introduced this time, documentation is still incomplete.
- Support for `not` keywords are still missing or partially working, please [read the docs](docs/USAGE.md) to see all supported keywords.
Since `RC16` comes with some deprecations and breaking-changes towards `v0.5.x` API:
- **deprecated** — You will not longer be able to call `jsf()` and get a fully-dereferenced result. It will just generate given refs and inline ones, nothing else.
- `jsf.generate()` is the sync-version, with partial dereferencing through given refs, etc.
......
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
......@@ -133,12 +133,13 @@ Below is the list of supported keywords:
- `required` — All required properties are guaranteed, if not can be omitted.
- `pattern` — Generate samples based on RegExp values.
- `format` — Core formats **v4-draft only**:
[`date-time`](http://json-schema.org/draft-04/json-schema-validation.html#anchor108),
- [`date-time`](http://json-schema.org/draft-04/json-schema-validation.html#anchor108),
[`email`](http://json-schema.org/draft-04/json-schema-validation.html#anchor111),
[`hostname`](http://json-schema.org/draft-04/json-schema-validation.html#anchor114),
[`ipv4`](http://json-schema.org/draft-04/json-schema-validation.html#anchor117),
[`ipv6`](http://json-schema.org/draft-04/json-schema-validation.html#anchor120)
and [`uri`](http://json-schema.org/draft-04/json-schema-validation.html#anchor123)
— also `uri-reference`, `uri-template`, `json-pointer` and `uuid` are supported.
-- [demo »](http://json-schema-faker.js.org/#gist/f58db80cbf52c12c623166090240d964)
- `enum` — Returns any of these enumerated values.
- `minLength`, `maxLength` — Applies length constraints to string values.
......@@ -154,7 +155,7 @@ Below is the list of supported keywords:
- `minProperties`, `maxProperties` — Adds length constraints for object properties.
- `patternProperties` — RegExp-based object properties.
- `additionalProperties` — Partially supported (?)
- `dependencies` — Not supported yet (?)
- `dependencies` — Partially supported (?)
- `not` — Not supported yet (?)
> Notice `not` support is complex to achieve and is probably will not work as you expected, most opened issues are related to that: so any feedback there is very appreaciated!
......@@ -340,6 +341,9 @@ You may define following options for `jsf` that alter its behavior:
jsf.option({
failOnInvalidTypes: false
});
// also valid
jsf.option('alwaysFakeOptionals', true);
```
> Please read the [available options here](./#available-options).
......
File suppressed by a .gitattributes entry or the file's encoding is unsupported.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment