Skip to content

Commit aab07d1

Browse files
pgonzalpgonzal
committed
Generate files
1 parent 6828fa1 commit aab07d1

173 files changed

Lines changed: 2305 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎api/node-core-library.ijsonfilesaveoptions.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- docId=node-core-library.ijsonfilesaveoptions -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md)
4+
5+
# IJsonFileSaveOptions interface
6+
7+
Options for JsonFile.saveJsonFile()
8+
9+
## Properties
10+
11+
| Property | Type | Description |
12+
| --- | --- | --- |
13+
| [`onlyIfChanged`](./node-core-library.ijsonfilesaveoptions.onlyifchanged.md) | `boolean` | If there is an existing file, and the contents have not changed, then don't write anything; this preserves the old timestamp. |
14+

‎api/node-core-library.ijsonfilesaveoptions.onlyifchanged.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=node-core-library.ijsonfilesaveoptions.onlyifchanged -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md) &gt; [IJsonFileSaveOptions](./node-core-library.ijsonfilesaveoptions.md)
4+
5+
# IJsonFileSaveOptions.onlyIfChanged property
6+
7+
If there is an existing file, and the contents have not changed, then don't write anything; this preserves the old timestamp.
8+
9+
**Signature:**
10+
```javascript
11+
onlyIfChanged: boolean
12+
```

‎api/node-core-library.ijsonfilestringifyoptions.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- docId=node-core-library.ijsonfilestringifyoptions -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md)
4+
5+
# IJsonFileStringifyOptions interface
6+
7+
Options for JsonFile.stringify()
8+
9+
## Properties
10+
11+
| Property | Type | Description |
12+
| --- | --- | --- |
13+
| [`unixNewlines`](./node-core-library.ijsonfilestringifyoptions.unixnewlines.md) | `boolean` | If true, then "\\n" will be used for newlines instead of the default "\r\n". |
14+

‎api/node-core-library.ijsonfilestringifyoptions.unixnewlines.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=node-core-library.ijsonfilestringifyoptions.unixnewlines -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md) &gt; [IJsonFileStringifyOptions](./node-core-library.ijsonfilestringifyoptions.md)
4+
5+
# IJsonFileStringifyOptions.unixNewlines property
6+
7+
If true, then "\\n" will be used for newlines instead of the default "\r\n".
8+
9+
**Signature:**
10+
```javascript
11+
unixNewlines: boolean
12+
```

‎api/node-core-library.ijsonschemaerrorinfo.details.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<!-- docId=node-core-library.ijsonschemaerrorinfo.details -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md) &gt; [IJsonSchemaErrorInfo](./node-core-library.ijsonschemaerrorinfo.md)
4+
5+
# IJsonSchemaErrorInfo.details property
6+
7+
The z-schema error tree, formatted as an indented text string.
8+
9+
**Signature:**
10+
```javascript
11+
details: string
12+
```

‎api/node-core-library.ijsonschemaerrorinfo.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- docId=node-core-library.ijsonschemaerrorinfo -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md)
4+
5+
# IJsonSchemaErrorInfo interface
6+
7+
Callback function arguments for JsonSchema.validateObjectWithCallback();
8+
9+
## Properties
10+
11+
| Property | Type | Description |
12+
| --- | --- | --- |
13+
| [`details`](./node-core-library.ijsonschemaerrorinfo.details.md) | `string` | The z-schema error tree, formatted as an indented text string. |
14+

‎api/node-core-library.ijsonschemafromfileoptions.dependentschemas.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- docId=node-core-library.ijsonschemafromfileoptions.dependentschemas -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md) &gt; [IJsonSchemaFromFileOptions](./node-core-library.ijsonschemafromfileoptions.md)
4+
5+
# IJsonSchemaFromFileOptions.dependentSchemas property
6+
7+
Other schemas that this schema references, e.g. via the "$ref" directive.
8+
9+
**Signature:**
10+
```javascript
11+
dependentSchemas: JsonSchema[]
12+
```
13+
14+
## Remarks
15+
16+
The tree of dependent schemas may reference the same schema more than once. However, if the same schema "id" is used by two different JsonSchema instances, an error will be reported. This means you cannot load the same filename twice and use them both together, and you cannot have diamond dependencies on different versions of the same schema. Although technically this would be possible to support, it normally indicates an error or design problem. JsonSchema also does not allow circular references between schema dependencies.

‎api/node-core-library.ijsonschemafromfileoptions.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- docId=node-core-library.ijsonschemafromfileoptions -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md)
4+
5+
# IJsonSchemaFromFileOptions interface
6+
7+
Options for JsonSchema.fromFile()
8+
9+
## Properties
10+
11+
| Property | Type | Description |
12+
| --- | --- | --- |
13+
| [`dependentSchemas`](./node-core-library.ijsonschemafromfileoptions.dependentschemas.md) | `JsonSchema[]` | Other schemas that this schema references, e.g. via the "$ref" directive. |
14+

‎api/node-core-library.ijsonschemavalidateoptions.customerrorheader.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- docId=node-core-library.ijsonschemavalidateoptions.customerrorheader -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md) &gt; [IJsonSchemaValidateOptions](./node-core-library.ijsonschemavalidateoptions.md)
4+
5+
# IJsonSchemaValidateOptions.customErrorHeader property
6+
7+
A custom header that will be used to report schema errors.
8+
9+
**Signature:**
10+
```javascript
11+
customErrorHeader: string
12+
```
13+
14+
## Remarks
15+
16+
If omitted, the default header is "JSON validation failed:". The error message starts with the header, followed by the full input filename, followed by the z-schema error tree. If you wish to customize all aspects of the error message, use JsonFile.loadAndValidateWithCallback() or JsonSchema.validateObjectWithCallback().

‎api/node-core-library.ijsonschemavalidateoptions.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!-- docId=node-core-library.ijsonschemavalidateoptions -->
2+
3+
[Home](./index.md) &gt; [node-core-library](./node-core-library.md)
4+
5+
# IJsonSchemaValidateOptions interface
6+
7+
Options for JsonSchema.validateObject()
8+
9+
## Properties
10+
11+
| Property | Type | Description |
12+
| --- | --- | --- |
13+
| [`customErrorHeader`](./node-core-library.ijsonschemavalidateoptions.customerrorheader.md) | `string` | A custom header that will be used to report schema errors. |
14+

0 commit comments

Comments
 (0)