@twin.org/data-json-ld 0.0.3-next.2 → 0.0.3-next.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/es/dataTypes/jsonLdDataTypes.js +104 -131
- package/dist/es/dataTypes/jsonLdDataTypes.js.map +1 -1
- package/dist/es/helpers/jsonLdHelperTypes.js +2 -0
- package/dist/es/helpers/jsonLdHelperTypes.js.map +1 -0
- package/dist/es/index.js +1 -0
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/jsonLdContexts.js +10 -2
- package/dist/es/models/jsonLdContexts.js.map +1 -1
- package/dist/es/schemas/JsonLdContainerType.json +17 -7
- package/dist/es/schemas/JsonLdContainerTypeArray.json +129 -142
- package/dist/es/schemas/JsonLdContextDefinition.json +76 -18
- package/dist/es/schemas/JsonLdContextDefinitionElement.json +1 -0
- package/dist/es/schemas/JsonLdContextDefinitionRoot.json +1 -0
- package/dist/es/schemas/JsonLdDocument.json +3 -3
- package/dist/es/schemas/JsonLdExpandedTermDefinition.json +101 -89
- package/dist/es/schemas/JsonLdGraphObject.json +2 -2
- package/dist/es/schemas/JsonLdIdMap.json +1 -0
- package/dist/es/schemas/JsonLdIncludedBlock.json +1 -0
- package/dist/es/schemas/JsonLdIndexMap.json +2 -1
- package/dist/es/schemas/JsonLdIndexMapItem.json +1 -0
- package/dist/es/schemas/JsonLdJsonArray.json +1 -0
- package/dist/es/schemas/JsonLdJsonObject.json +2 -8
- package/dist/es/schemas/JsonLdJsonPrimitive.json +14 -5
- package/dist/es/schemas/JsonLdJsonValue.json +1 -0
- package/dist/es/schemas/JsonLdLanguageMap.json +1 -0
- package/dist/es/schemas/JsonLdListObject.json +2 -2
- package/dist/es/schemas/JsonLdListOrSetItem.json +1 -0
- package/dist/es/schemas/JsonLdNodeObject.json +12 -72
- package/dist/es/schemas/JsonLdNodePrimitive.json +1 -0
- package/dist/es/schemas/JsonLdObject.json +3 -3
- package/dist/es/schemas/JsonLdSetObject.json +2 -2
- package/dist/es/schemas/JsonLdTypeMap.json +1 -0
- package/dist/es/schemas/JsonLdValueObject.json +99 -87
- package/dist/es/utils/jsonLdHelper.js +181 -15
- package/dist/es/utils/jsonLdHelper.js.map +1 -1
- package/dist/es/utils/jsonLdProcessor.js +125 -34
- package/dist/es/utils/jsonLdProcessor.js.map +1 -1
- package/dist/types/helpers/jsonLdHelperTypes.d.ts +127 -0
- package/dist/types/index.d.ts +1 -0
- package/dist/types/models/jsonLdContexts.d.ts +10 -2
- package/dist/types/utils/jsonLdHelper.d.ts +63 -6
- package/dist/types/utils/jsonLdProcessor.d.ts +10 -7
- package/docs/changelog.md +349 -63
- package/docs/examples.md +214 -1
- package/docs/reference/classes/JsonLdDataTypes.md +1 -1
- package/docs/reference/classes/JsonLdHelper.md +249 -13
- package/docs/reference/classes/JsonLdProcessor.md +51 -58
- package/docs/reference/index.md +23 -0
- package/docs/reference/interfaces/IJsonLdContextDefinition.md +20 -20
- package/docs/reference/interfaces/IJsonLdGraphObject.md +7 -7
- package/docs/reference/interfaces/IJsonLdIdMap.md +1 -1
- package/docs/reference/interfaces/IJsonLdIndexMap.md +1 -1
- package/docs/reference/interfaces/IJsonLdJsonObject.md +1 -1
- package/docs/reference/interfaces/IJsonLdLanguageMap.md +1 -1
- package/docs/reference/interfaces/IJsonLdListObject.md +3 -3
- package/docs/reference/interfaces/IJsonLdNodeObject.md +17 -17
- package/docs/reference/interfaces/IJsonLdObject.md +16 -16
- package/docs/reference/interfaces/IJsonLdSetObject.md +3 -3
- package/docs/reference/interfaces/IJsonLdTypeMap.md +1 -1
- package/docs/reference/type-aliases/IJsonLdExpandedTermDefinition.md +7 -7
- package/docs/reference/type-aliases/IJsonLdValueObject.md +2 -2
- package/docs/reference/type-aliases/JsonLdAliasKey.md +15 -0
- package/docs/reference/type-aliases/JsonLdExistingProperty.md +19 -0
- package/docs/reference/type-aliases/JsonLdExistingPropertyEither.md +24 -0
- package/docs/reference/type-aliases/JsonLdKeys.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithAliases.md +16 -0
- package/docs/reference/type-aliases/JsonLdObjectWithAtId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithAtType.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithContext.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoAtId.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoAtType.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoContext.md +12 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoId.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithNoType.md +11 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalAtId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalAtType.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalContext.md +22 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalId.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithOptionalType.md +21 -0
- package/docs/reference/type-aliases/JsonLdObjectWithType.md +21 -0
- package/docs/reference/type-aliases/JsonLdOptionalKeys.md +11 -0
- package/docs/reference/type-aliases/JsonLdRequiredKeys.md +11 -0
- package/docs/reference/type-aliases/JsonLdWithAliases.md +17 -0
- package/docs/reference/variables/JsonLdContexts.md +15 -3
- package/docs/reference/variables/JsonLdTypes.md +26 -26
- package/package.json +6 -6
|
@@ -14,7 +14,7 @@ JSON-LD Processor.
|
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
|
17
|
-
### setDocumentLoader()
|
|
17
|
+
### setDocumentLoader() {#setdocumentloader}
|
|
18
18
|
|
|
19
19
|
> `static` **setDocumentLoader**(`documentLoader`): `void`
|
|
20
20
|
|
|
@@ -34,7 +34,7 @@ The document loader to use.
|
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
37
|
-
### getDocumentLoader()
|
|
37
|
+
### getDocumentLoader() {#getdocumentloader}
|
|
38
38
|
|
|
39
39
|
> `static` **getDocumentLoader**(): (`url`) => `Promise`\<`RemoteDocument`\>
|
|
40
40
|
|
|
@@ -44,21 +44,11 @@ The document loader to use for retrieving JSON-LD documents.
|
|
|
44
44
|
|
|
45
45
|
The document loader.
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
##### Parameters
|
|
50
|
-
|
|
51
|
-
###### url
|
|
52
|
-
|
|
53
|
-
`string`
|
|
54
|
-
|
|
55
|
-
##### Returns
|
|
56
|
-
|
|
57
|
-
`Promise`\<`RemoteDocument`\>
|
|
47
|
+
(`url`) => `Promise`\<`RemoteDocument`\>
|
|
58
48
|
|
|
59
49
|
***
|
|
60
50
|
|
|
61
|
-
### setCacheLimit()
|
|
51
|
+
### setCacheLimit() {#setcachelimit}
|
|
62
52
|
|
|
63
53
|
> `static` **setCacheLimit**(`cacheLimitMs`): `void`
|
|
64
54
|
|
|
@@ -78,7 +68,7 @@ The cache limit in milliseconds.
|
|
|
78
68
|
|
|
79
69
|
***
|
|
80
70
|
|
|
81
|
-
### getCacheLimit()
|
|
71
|
+
### getCacheLimit() {#getcachelimit}
|
|
82
72
|
|
|
83
73
|
> `static` **getCacheLimit**(): `number`
|
|
84
74
|
|
|
@@ -92,11 +82,12 @@ The document loader.
|
|
|
92
82
|
|
|
93
83
|
***
|
|
94
84
|
|
|
95
|
-
### setRedirects()
|
|
85
|
+
### setRedirects() {#setredirects}
|
|
96
86
|
|
|
97
87
|
> `static` **setRedirects**(`redirects`): `void`
|
|
98
88
|
|
|
99
|
-
|
|
89
|
+
Replace the global redirect list (use [JsonLdProcessor.addRedirect](#addredirect) to append without replacing).
|
|
90
|
+
Redirects run before any HTTP GET or `Link` discovery; use them for stable overrides, tests, or hosts that do not expose a suitable `Link` header.
|
|
100
91
|
|
|
101
92
|
#### Parameters
|
|
102
93
|
|
|
@@ -112,7 +103,7 @@ The redirects to use.
|
|
|
112
103
|
|
|
113
104
|
***
|
|
114
105
|
|
|
115
|
-
### getRedirects()
|
|
106
|
+
### getRedirects() {#getredirects}
|
|
116
107
|
|
|
117
108
|
> `static` **getRedirects**(): `object`[]
|
|
118
109
|
|
|
@@ -126,7 +117,35 @@ The registered redirects.
|
|
|
126
117
|
|
|
127
118
|
***
|
|
128
119
|
|
|
129
|
-
###
|
|
120
|
+
### addRedirect() {#addredirect}
|
|
121
|
+
|
|
122
|
+
> `static` **addRedirect**(`from`, `to`): `void`
|
|
123
|
+
|
|
124
|
+
Append a redirect rule (ignored if the same `RegExp.source` is already registered).
|
|
125
|
+
Optional when the vocabulary URL supports HTTP `Link` discovery (`rel` includes `alternate`, `type` is `application/ld+json`) via the default document loader.
|
|
126
|
+
Standards packages often expose `registerRedirects()` helpers that call this method; those are optional for the same reason.
|
|
127
|
+
|
|
128
|
+
#### Parameters
|
|
129
|
+
|
|
130
|
+
##### from
|
|
131
|
+
|
|
132
|
+
`RegExp`
|
|
133
|
+
|
|
134
|
+
The URL to redirect from.
|
|
135
|
+
|
|
136
|
+
##### to
|
|
137
|
+
|
|
138
|
+
`string`
|
|
139
|
+
|
|
140
|
+
The URL to redirect to.
|
|
141
|
+
|
|
142
|
+
#### Returns
|
|
143
|
+
|
|
144
|
+
`void`
|
|
145
|
+
|
|
146
|
+
***
|
|
147
|
+
|
|
148
|
+
### compact() {#compact}
|
|
130
149
|
|
|
131
150
|
> `static` **compact**\<`T`\>(`document`, `context?`, `options?`): `Promise`\<`T`\>
|
|
132
151
|
|
|
@@ -170,7 +189,7 @@ The compacted JSON-LD document.
|
|
|
170
189
|
|
|
171
190
|
***
|
|
172
191
|
|
|
173
|
-
### expand()
|
|
192
|
+
### expand() {#expand}
|
|
174
193
|
|
|
175
194
|
> `static` **expand**\<`T`\>(`compacted`): `Promise`\<[`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]\>
|
|
176
195
|
|
|
@@ -198,7 +217,7 @@ The expanded JSON-LD document.
|
|
|
198
217
|
|
|
199
218
|
***
|
|
200
219
|
|
|
201
|
-
### canonize()
|
|
220
|
+
### canonize() {#canonize}
|
|
202
221
|
|
|
203
222
|
> `static` **canonize**\<`T`\>(`document`, `options?`): `Promise`\<`string`\>
|
|
204
223
|
|
|
@@ -236,33 +255,7 @@ The canonized document.
|
|
|
236
255
|
|
|
237
256
|
***
|
|
238
257
|
|
|
239
|
-
###
|
|
240
|
-
|
|
241
|
-
> `static` **addRedirect**(`from`, `to`): `void`
|
|
242
|
-
|
|
243
|
-
Add a redirect to use during document resolution.
|
|
244
|
-
|
|
245
|
-
#### Parameters
|
|
246
|
-
|
|
247
|
-
##### from
|
|
248
|
-
|
|
249
|
-
`RegExp`
|
|
250
|
-
|
|
251
|
-
The URL to redirect from.
|
|
252
|
-
|
|
253
|
-
##### to
|
|
254
|
-
|
|
255
|
-
`string`
|
|
256
|
-
|
|
257
|
-
The URL to redirect to.
|
|
258
|
-
|
|
259
|
-
#### Returns
|
|
260
|
-
|
|
261
|
-
`void`
|
|
262
|
-
|
|
263
|
-
***
|
|
264
|
-
|
|
265
|
-
### combineContexts()
|
|
258
|
+
### combineContexts() {#combinecontexts}
|
|
266
259
|
|
|
267
260
|
> `static` **combineContexts**(`context1`, `context2`): [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
|
|
268
261
|
|
|
@@ -272,15 +265,15 @@ Combine contexts.
|
|
|
272
265
|
|
|
273
266
|
##### context1
|
|
274
267
|
|
|
275
|
-
|
|
268
|
+
[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
|
|
276
269
|
|
|
277
|
-
|
|
270
|
+
The first JSON-LD context to combine.
|
|
278
271
|
|
|
279
272
|
##### context2
|
|
280
273
|
|
|
281
|
-
|
|
274
|
+
[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
|
|
282
275
|
|
|
283
|
-
|
|
276
|
+
The second JSON-LD context to combine.
|
|
284
277
|
|
|
285
278
|
#### Returns
|
|
286
279
|
|
|
@@ -290,7 +283,7 @@ The combined context.
|
|
|
290
283
|
|
|
291
284
|
***
|
|
292
285
|
|
|
293
|
-
### gatherContexts()
|
|
286
|
+
### gatherContexts() {#gathercontexts}
|
|
294
287
|
|
|
295
288
|
> `static` **gatherContexts**\<`T`\>(`element`, `initial?`): [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
|
|
296
289
|
|
|
@@ -324,7 +317,7 @@ The combined contexts.
|
|
|
324
317
|
|
|
325
318
|
***
|
|
326
319
|
|
|
327
|
-
### removeContexts()
|
|
320
|
+
### removeContexts() {#removecontexts}
|
|
328
321
|
|
|
329
322
|
> `static` **removeContexts**(`context`, `match?`): [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
|
|
330
323
|
|
|
@@ -334,9 +327,9 @@ Remove all the contexts that match the pattern.
|
|
|
334
327
|
|
|
335
328
|
##### context
|
|
336
329
|
|
|
337
|
-
|
|
330
|
+
[`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md) \| `undefined`
|
|
338
331
|
|
|
339
|
-
|
|
332
|
+
The context to remove the entries from.
|
|
340
333
|
|
|
341
334
|
##### match?
|
|
342
335
|
|
|
@@ -352,7 +345,7 @@ The updated contexts.
|
|
|
352
345
|
|
|
353
346
|
***
|
|
354
347
|
|
|
355
|
-
### documentCacheAdd()
|
|
348
|
+
### documentCacheAdd() {#documentcacheadd}
|
|
356
349
|
|
|
357
350
|
> `static` **documentCacheAdd**(`url`, `ldContext`): `Promise`\<`void`\>
|
|
358
351
|
|
|
@@ -380,7 +373,7 @@ Nothing.
|
|
|
380
373
|
|
|
381
374
|
***
|
|
382
375
|
|
|
383
|
-
### documentCacheRemove()
|
|
376
|
+
### documentCacheRemove() {#documentcacheremove}
|
|
384
377
|
|
|
385
378
|
> `static` **documentCacheRemove**(`url`): `Promise`\<`void`\>
|
|
386
379
|
|
package/docs/reference/index.md
CHANGED
|
@@ -22,6 +22,29 @@
|
|
|
22
22
|
|
|
23
23
|
## Type Aliases
|
|
24
24
|
|
|
25
|
+
- [JsonLdOptionalKeys](type-aliases/JsonLdOptionalKeys.md)
|
|
26
|
+
- [JsonLdRequiredKeys](type-aliases/JsonLdRequiredKeys.md)
|
|
27
|
+
- [JsonLdAliasKey](type-aliases/JsonLdAliasKey.md)
|
|
28
|
+
- [JsonLdWithAliases](type-aliases/JsonLdWithAliases.md)
|
|
29
|
+
- [JsonLdKeys](type-aliases/JsonLdKeys.md)
|
|
30
|
+
- [JsonLdObjectWithAliases](type-aliases/JsonLdObjectWithAliases.md)
|
|
31
|
+
- [JsonLdObjectWithContext](type-aliases/JsonLdObjectWithContext.md)
|
|
32
|
+
- [JsonLdExistingProperty](type-aliases/JsonLdExistingProperty.md)
|
|
33
|
+
- [JsonLdExistingPropertyEither](type-aliases/JsonLdExistingPropertyEither.md)
|
|
34
|
+
- [JsonLdObjectWithOptionalContext](type-aliases/JsonLdObjectWithOptionalContext.md)
|
|
35
|
+
- [JsonLdObjectWithNoContext](type-aliases/JsonLdObjectWithNoContext.md)
|
|
36
|
+
- [JsonLdObjectWithType](type-aliases/JsonLdObjectWithType.md)
|
|
37
|
+
- [JsonLdObjectWithOptionalType](type-aliases/JsonLdObjectWithOptionalType.md)
|
|
38
|
+
- [JsonLdObjectWithNoType](type-aliases/JsonLdObjectWithNoType.md)
|
|
39
|
+
- [JsonLdObjectWithAtType](type-aliases/JsonLdObjectWithAtType.md)
|
|
40
|
+
- [JsonLdObjectWithOptionalAtType](type-aliases/JsonLdObjectWithOptionalAtType.md)
|
|
41
|
+
- [JsonLdObjectWithNoAtType](type-aliases/JsonLdObjectWithNoAtType.md)
|
|
42
|
+
- [JsonLdObjectWithId](type-aliases/JsonLdObjectWithId.md)
|
|
43
|
+
- [JsonLdObjectWithOptionalId](type-aliases/JsonLdObjectWithOptionalId.md)
|
|
44
|
+
- [JsonLdObjectWithNoId](type-aliases/JsonLdObjectWithNoId.md)
|
|
45
|
+
- [JsonLdObjectWithAtId](type-aliases/JsonLdObjectWithAtId.md)
|
|
46
|
+
- [JsonLdObjectWithOptionalAtId](type-aliases/JsonLdObjectWithOptionalAtId.md)
|
|
47
|
+
- [JsonLdObjectWithNoAtId](type-aliases/JsonLdObjectWithNoAtId.md)
|
|
25
48
|
- [IJsonLdContainerType](type-aliases/IJsonLdContainerType.md)
|
|
26
49
|
- [IJsonLdContainerTypeArray](type-aliases/IJsonLdContainerTypeArray.md)
|
|
27
50
|
- [IJsonLdContextDefinitionElement](type-aliases/IJsonLdContextDefinitionElement.md)
|
|
@@ -8,49 +8,49 @@ https://www.w3.org/TR/json-ld11/#context-definitions
|
|
|
8
8
|
|
|
9
9
|
## Indexable
|
|
10
10
|
|
|
11
|
-
\[`key`: `string`\]: `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected?`: `boolean`; \} \| `null` \| `undefined`
|
|
11
|
+
> \[`key`: `string`\]: `string` \| `boolean` \| [`IJsonLdExpandedTermDefinition`](../type-aliases/IJsonLdExpandedTermDefinition.md) \| \{ `@container`: `"@set"`; `@protected?`: `boolean`; \} \| `null` \| `undefined`
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
-
### @base?
|
|
15
|
+
### @base? {#base}
|
|
16
16
|
|
|
17
|
-
> `optional` **@base
|
|
17
|
+
> `optional` **@base?**: `string` \| `null`
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
21
|
-
### @direction?
|
|
21
|
+
### @direction? {#direction}
|
|
22
22
|
|
|
23
|
-
> `optional` **@direction
|
|
23
|
+
> `optional` **@direction?**: `"ltr"` \| `"rtl"` \| `null`
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
27
|
-
### @import?
|
|
27
|
+
### @import? {#import}
|
|
28
28
|
|
|
29
|
-
> `optional` **@import
|
|
29
|
+
> `optional` **@import?**: `string`
|
|
30
30
|
|
|
31
31
|
***
|
|
32
32
|
|
|
33
|
-
### @language?
|
|
33
|
+
### @language? {#language}
|
|
34
34
|
|
|
35
|
-
> `optional` **@language
|
|
35
|
+
> `optional` **@language?**: `string`
|
|
36
36
|
|
|
37
37
|
***
|
|
38
38
|
|
|
39
|
-
### @propagate?
|
|
39
|
+
### @propagate? {#propagate}
|
|
40
40
|
|
|
41
|
-
> `optional` **@propagate
|
|
41
|
+
> `optional` **@propagate?**: `boolean`
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
|
-
### @protected?
|
|
45
|
+
### @protected? {#protected}
|
|
46
46
|
|
|
47
|
-
> `optional` **@protected
|
|
47
|
+
> `optional` **@protected?**: `boolean`
|
|
48
48
|
|
|
49
49
|
***
|
|
50
50
|
|
|
51
|
-
### @type?
|
|
51
|
+
### @type? {#type}
|
|
52
52
|
|
|
53
|
-
> `optional` **@type
|
|
53
|
+
> `optional` **@type?**: `object`
|
|
54
54
|
|
|
55
55
|
#### @container
|
|
56
56
|
|
|
@@ -58,16 +58,16 @@ https://www.w3.org/TR/json-ld11/#context-definitions
|
|
|
58
58
|
|
|
59
59
|
#### @protected?
|
|
60
60
|
|
|
61
|
-
> `optional` **@protected
|
|
61
|
+
> `optional` **@protected?**: `boolean`
|
|
62
62
|
|
|
63
63
|
***
|
|
64
64
|
|
|
65
|
-
### @version?
|
|
65
|
+
### @version? {#version}
|
|
66
66
|
|
|
67
|
-
> `optional` **@version
|
|
67
|
+
> `optional` **@version?**: `"1.1"`
|
|
68
68
|
|
|
69
69
|
***
|
|
70
70
|
|
|
71
|
-
### @vocab?
|
|
71
|
+
### @vocab? {#vocab}
|
|
72
72
|
|
|
73
|
-
> `optional` **@vocab
|
|
73
|
+
> `optional` **@vocab?**: `string` \| `null`
|
|
@@ -8,24 +8,24 @@ https://www.w3.org/TR/json-ld11/#graph-objects
|
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
11
|
-
### @graph
|
|
11
|
+
### @graph {#graph}
|
|
12
12
|
|
|
13
13
|
> **@graph**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### @index?
|
|
17
|
+
### @index? {#index}
|
|
18
18
|
|
|
19
|
-
> `optional` **@index
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
### @id?
|
|
23
|
+
### @id? {#id}
|
|
24
24
|
|
|
25
|
-
> `optional` **@id
|
|
25
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
29
|
-
### @context?
|
|
29
|
+
### @context? {#context}
|
|
30
30
|
|
|
31
|
-
> `optional` **@context
|
|
31
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
@@ -9,4 +9,4 @@ https://www.w3.org/TR/json-ld11/#index-maps
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]
|
|
12
|
+
> \[`key`: `string`\]: [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md) \| [`IJsonLdIndexMapItem`](../type-aliases/IJsonLdIndexMapItem.md)[]
|
|
@@ -8,12 +8,12 @@ https://www.w3.org/TR/json-ld11/#lists-and-sets
|
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
11
|
-
### @list
|
|
11
|
+
### @list {#list}
|
|
12
12
|
|
|
13
13
|
> **@list**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### @index?
|
|
17
|
+
### @index? {#index}
|
|
18
18
|
|
|
19
|
-
> `optional` **@index
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
@@ -13,13 +13,13 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
13
13
|
|
|
14
14
|
## Indexable
|
|
15
15
|
|
|
16
|
-
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| `IJsonLdNodeObject` \| `IJsonLdNodeObject`[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdListObject`](IJsonLdListObject.md) \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{\[`key`: `string`\]: `string`; \} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `null` \| `undefined`
|
|
16
|
+
> \[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| [`IJsonLdContextDefinition`](IJsonLdContextDefinition.md) \| [`IJsonLdContextDefinitionElement`](../type-aliases/IJsonLdContextDefinitionElement.md)[] \| [`IJsonLdIdMap`](IJsonLdIdMap.md) \| `IJsonLdNodeObject` \| `IJsonLdNodeObject`[] \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| `object` & `object` \| `object` & `object` \| `object` & `object` \| [`IJsonLdListObject`](IJsonLdListObject.md) \| [`IJsonLdSetObject`](IJsonLdSetObject.md) \| [`IJsonLdIndexMap`](IJsonLdIndexMap.md) \| [`IJsonLdLanguageMap`](IJsonLdLanguageMap.md) \| [`IJsonLdGraphObject`](IJsonLdGraphObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[] \| \{\[`key`: `string`\]: `string`; \} \| [`IJsonLdTypeMap`](IJsonLdTypeMap.md) \| [`IJsonLdNodePrimitive`](../type-aliases/IJsonLdNodePrimitive.md)[] \| `null` \| `undefined`
|
|
17
17
|
|
|
18
18
|
## Properties
|
|
19
19
|
|
|
20
|
-
### @context?
|
|
20
|
+
### @context? {#context}
|
|
21
21
|
|
|
22
|
-
> `optional` **@context
|
|
22
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
23
23
|
|
|
24
24
|
#### Inherited from
|
|
25
25
|
|
|
@@ -27,9 +27,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
27
27
|
|
|
28
28
|
***
|
|
29
29
|
|
|
30
|
-
### @id?
|
|
30
|
+
### @id? {#id}
|
|
31
31
|
|
|
32
|
-
> `optional` **@id
|
|
32
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
33
33
|
|
|
34
34
|
#### Inherited from
|
|
35
35
|
|
|
@@ -37,9 +37,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
37
37
|
|
|
38
38
|
***
|
|
39
39
|
|
|
40
|
-
### @included?
|
|
40
|
+
### @included? {#included}
|
|
41
41
|
|
|
42
|
-
> `optional` **@included
|
|
42
|
+
> `optional` **@included?**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
|
|
43
43
|
|
|
44
44
|
#### Inherited from
|
|
45
45
|
|
|
@@ -47,9 +47,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
50
|
-
### @graph?
|
|
50
|
+
### @graph? {#graph}
|
|
51
51
|
|
|
52
|
-
> `optional` **@graph
|
|
52
|
+
> `optional` **@graph?**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
|
|
53
53
|
|
|
54
54
|
#### Inherited from
|
|
55
55
|
|
|
@@ -57,9 +57,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
57
57
|
|
|
58
58
|
***
|
|
59
59
|
|
|
60
|
-
### @nest?
|
|
60
|
+
### @nest? {#nest}
|
|
61
61
|
|
|
62
|
-
> `optional` **@nest
|
|
62
|
+
> `optional` **@nest?**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
|
|
63
63
|
|
|
64
64
|
#### Inherited from
|
|
65
65
|
|
|
@@ -67,9 +67,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
67
67
|
|
|
68
68
|
***
|
|
69
69
|
|
|
70
|
-
### @type?
|
|
70
|
+
### @type? {#type}
|
|
71
71
|
|
|
72
|
-
> `optional` **@type
|
|
72
|
+
> `optional` **@type?**: `string` \| `string`[]
|
|
73
73
|
|
|
74
74
|
#### Inherited from
|
|
75
75
|
|
|
@@ -77,9 +77,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
77
77
|
|
|
78
78
|
***
|
|
79
79
|
|
|
80
|
-
### @reverse?
|
|
80
|
+
### @reverse? {#reverse}
|
|
81
81
|
|
|
82
|
-
> `optional` **@reverse
|
|
82
|
+
> `optional` **@reverse?**: `object`
|
|
83
83
|
|
|
84
84
|
#### Index Signature
|
|
85
85
|
|
|
@@ -91,9 +91,9 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
91
91
|
|
|
92
92
|
***
|
|
93
93
|
|
|
94
|
-
### @index?
|
|
94
|
+
### @index? {#index}
|
|
95
95
|
|
|
96
|
-
> `optional` **@index
|
|
96
|
+
> `optional` **@index?**: `string`
|
|
97
97
|
|
|
98
98
|
#### Inherited from
|
|
99
99
|
|
|
@@ -13,45 +13,45 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
### @context?
|
|
16
|
+
### @context? {#context}
|
|
17
17
|
|
|
18
|
-
> `optional` **@context
|
|
18
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
19
19
|
|
|
20
20
|
***
|
|
21
21
|
|
|
22
|
-
### @id?
|
|
22
|
+
### @id? {#id}
|
|
23
23
|
|
|
24
|
-
> `optional` **@id
|
|
24
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
28
|
-
### @included?
|
|
28
|
+
### @included? {#included}
|
|
29
29
|
|
|
30
|
-
> `optional` **@included
|
|
30
|
+
> `optional` **@included?**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
|
|
31
31
|
|
|
32
32
|
***
|
|
33
33
|
|
|
34
|
-
### @graph?
|
|
34
|
+
### @graph? {#graph}
|
|
35
35
|
|
|
36
|
-
> `optional` **@graph
|
|
36
|
+
> `optional` **@graph?**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
|
|
37
37
|
|
|
38
38
|
***
|
|
39
39
|
|
|
40
|
-
### @nest?
|
|
40
|
+
### @nest? {#nest}
|
|
41
41
|
|
|
42
|
-
> `optional` **@nest
|
|
42
|
+
> `optional` **@nest?**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
|
|
43
43
|
|
|
44
44
|
***
|
|
45
45
|
|
|
46
|
-
### @type?
|
|
46
|
+
### @type? {#type}
|
|
47
47
|
|
|
48
|
-
> `optional` **@type
|
|
48
|
+
> `optional` **@type?**: `string` \| `string`[]
|
|
49
49
|
|
|
50
50
|
***
|
|
51
51
|
|
|
52
|
-
### @reverse?
|
|
52
|
+
### @reverse? {#reverse}
|
|
53
53
|
|
|
54
|
-
> `optional` **@reverse
|
|
54
|
+
> `optional` **@reverse?**: `object`
|
|
55
55
|
|
|
56
56
|
#### Index Signature
|
|
57
57
|
|
|
@@ -59,6 +59,6 @@ https://www.w3.org/TR/json-ld11/#node-objects
|
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
62
|
-
### @index?
|
|
62
|
+
### @index? {#index}
|
|
63
63
|
|
|
64
|
-
> `optional` **@index
|
|
64
|
+
> `optional` **@index?**: `string`
|
|
@@ -8,12 +8,12 @@ https://www.w3.org/TR/json-ld11/#lists-and-sets
|
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
11
|
-
### @set
|
|
11
|
+
### @set {#set}
|
|
12
12
|
|
|
13
13
|
> **@set**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
### @index?
|
|
17
|
+
### @index? {#index}
|
|
18
18
|
|
|
19
|
-
> `optional` **@index
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
@@ -10,31 +10,31 @@ associated with the term when it is used as key in a node object.
|
|
|
10
10
|
|
|
11
11
|
### @type?
|
|
12
12
|
|
|
13
|
-
> `optional` **@type
|
|
13
|
+
> `optional` **@type?**: `"@id"` \| `"@json"` \| `"@none"` \| `"@vocab"` \| `string`
|
|
14
14
|
|
|
15
15
|
### @language?
|
|
16
16
|
|
|
17
|
-
> `optional` **@language
|
|
17
|
+
> `optional` **@language?**: `string`
|
|
18
18
|
|
|
19
19
|
### @index?
|
|
20
20
|
|
|
21
|
-
> `optional` **@index
|
|
21
|
+
> `optional` **@index?**: `string`
|
|
22
22
|
|
|
23
23
|
### @context?
|
|
24
24
|
|
|
25
|
-
> `optional` **@context
|
|
25
|
+
> `optional` **@context?**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
|
|
26
26
|
|
|
27
27
|
### @prefix?
|
|
28
28
|
|
|
29
|
-
> `optional` **@prefix
|
|
29
|
+
> `optional` **@prefix?**: `boolean`
|
|
30
30
|
|
|
31
31
|
### @propagate?
|
|
32
32
|
|
|
33
|
-
> `optional` **@propagate
|
|
33
|
+
> `optional` **@propagate?**: `boolean`
|
|
34
34
|
|
|
35
35
|
### @protected?
|
|
36
36
|
|
|
37
|
-
> `optional` **@protected
|
|
37
|
+
> `optional` **@protected?**: `boolean`
|
|
38
38
|
|
|
39
39
|
## See
|
|
40
40
|
|
|
@@ -9,11 +9,11 @@ to create a typed value or a language-tagged string and possibly associate a bas
|
|
|
9
9
|
|
|
10
10
|
### @index?
|
|
11
11
|
|
|
12
|
-
> `optional` **@index
|
|
12
|
+
> `optional` **@index?**: `string`
|
|
13
13
|
|
|
14
14
|
### @context?
|
|
15
15
|
|
|
16
|
-
> `optional` **@context
|
|
16
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)
|
|
17
17
|
|
|
18
18
|
## See
|
|
19
19
|
|