@3sixty/data-json-ld 0.0.0-stage → 0.20.0-next.1
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/LICENSE +201 -0
- package/README.md +24 -2
- package/dist/es/compiled/validators.js +3895 -0
- package/dist/es/compiled/validators.js.map +1 -0
- package/dist/es/dataTypes/jsonLdDataTypes.js +170 -0
- package/dist/es/dataTypes/jsonLdDataTypes.js.map +1 -0
- package/dist/es/helpers/jsonLdAliasKey.js +4 -0
- package/dist/es/helpers/jsonLdAliasKey.js.map +1 -0
- package/dist/es/helpers/jsonLdExistingProperty.js +4 -0
- package/dist/es/helpers/jsonLdExistingProperty.js.map +1 -0
- package/dist/es/helpers/jsonLdExistingPropertyEither.js +2 -0
- package/dist/es/helpers/jsonLdExistingPropertyEither.js.map +1 -0
- package/dist/es/helpers/jsonLdKeys.js +4 -0
- package/dist/es/helpers/jsonLdKeys.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithAliases.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithAliases.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithAtId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithAtId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithAtType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithAtType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithContext.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithContext.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtId.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtType.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoAtType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoContext.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoContext.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoId.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithNoType.js +4 -0
- package/dist/es/helpers/jsonLdObjectWithNoType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalAtType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalContext.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalContext.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalId.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalId.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithOptionalType.js.map +1 -0
- package/dist/es/helpers/jsonLdObjectWithType.js +2 -0
- package/dist/es/helpers/jsonLdObjectWithType.js.map +1 -0
- package/dist/es/helpers/jsonLdOptionalKeys.js +4 -0
- package/dist/es/helpers/jsonLdOptionalKeys.js.map +1 -0
- package/dist/es/helpers/jsonLdRequiredKeys.js +2 -0
- package/dist/es/helpers/jsonLdRequiredKeys.js.map +1 -0
- package/dist/es/helpers/jsonLdWithAliases.js +2 -0
- package/dist/es/helpers/jsonLdWithAliases.js.map +1 -0
- package/dist/es/index.js +57 -0
- package/dist/es/index.js.map +1 -0
- package/dist/es/models/IJsonLdContainerType.js +4 -0
- package/dist/es/models/IJsonLdContainerType.js.map +1 -0
- package/dist/es/models/IJsonLdContainerTypeArray.js +2 -0
- package/dist/es/models/IJsonLdContainerTypeArray.js.map +1 -0
- package/dist/es/models/IJsonLdContextDefinition.js +2 -0
- package/dist/es/models/IJsonLdContextDefinition.js.map +1 -0
- package/dist/es/models/IJsonLdContextDefinitionElement.js +2 -0
- package/dist/es/models/IJsonLdContextDefinitionElement.js.map +1 -0
- package/dist/es/models/IJsonLdContextDefinitionRoot.js +2 -0
- package/dist/es/models/IJsonLdContextDefinitionRoot.js.map +1 -0
- package/dist/es/models/IJsonLdDocument.js +2 -0
- package/dist/es/models/IJsonLdDocument.js.map +1 -0
- package/dist/es/models/IJsonLdExpandedTermDefinition.js +2 -0
- package/dist/es/models/IJsonLdExpandedTermDefinition.js.map +1 -0
- package/dist/es/models/IJsonLdGraphObject.js +2 -0
- package/dist/es/models/IJsonLdGraphObject.js.map +1 -0
- package/dist/es/models/IJsonLdIdMap.js +2 -0
- package/dist/es/models/IJsonLdIdMap.js.map +1 -0
- package/dist/es/models/IJsonLdIncludedBlock.js +2 -0
- package/dist/es/models/IJsonLdIncludedBlock.js.map +1 -0
- package/dist/es/models/IJsonLdIndexMap.js +2 -0
- package/dist/es/models/IJsonLdIndexMap.js.map +1 -0
- package/dist/es/models/IJsonLdIndexMapItem.js +2 -0
- package/dist/es/models/IJsonLdIndexMapItem.js.map +1 -0
- package/dist/es/models/IJsonLdJsonArray.js +2 -0
- package/dist/es/models/IJsonLdJsonArray.js.map +1 -0
- package/dist/es/models/IJsonLdJsonObject.js +2 -0
- package/dist/es/models/IJsonLdJsonObject.js.map +1 -0
- package/dist/es/models/IJsonLdJsonPrimitive.js +4 -0
- package/dist/es/models/IJsonLdJsonPrimitive.js.map +1 -0
- package/dist/es/models/IJsonLdJsonValue.js +2 -0
- package/dist/es/models/IJsonLdJsonValue.js.map +1 -0
- package/dist/es/models/IJsonLdLanguageMap.js +4 -0
- package/dist/es/models/IJsonLdLanguageMap.js.map +1 -0
- package/dist/es/models/IJsonLdListObject.js +2 -0
- package/dist/es/models/IJsonLdListObject.js.map +1 -0
- package/dist/es/models/IJsonLdListOrSetItem.js +2 -0
- package/dist/es/models/IJsonLdListOrSetItem.js.map +1 -0
- package/dist/es/models/IJsonLdNodeObject.js +2 -0
- package/dist/es/models/IJsonLdNodeObject.js.map +1 -0
- package/dist/es/models/IJsonLdNodePrimitive.js +2 -0
- package/dist/es/models/IJsonLdNodePrimitive.js.map +1 -0
- package/dist/es/models/IJsonLdObject.js +2 -0
- package/dist/es/models/IJsonLdObject.js.map +1 -0
- package/dist/es/models/IJsonLdSetObject.js +2 -0
- package/dist/es/models/IJsonLdSetObject.js.map +1 -0
- package/dist/es/models/IJsonLdTypeMap.js +2 -0
- package/dist/es/models/IJsonLdTypeMap.js.map +1 -0
- package/dist/es/models/IJsonLdValueObject.js +2 -0
- package/dist/es/models/IJsonLdValueObject.js.map +1 -0
- package/dist/es/models/jsonLdContexts.js +21 -0
- package/dist/es/models/jsonLdContexts.js.map +1 -0
- package/dist/es/models/jsonLdTypes.js +113 -0
- package/dist/es/models/jsonLdTypes.js.map +1 -0
- package/dist/es/schemas/JsonLdContainerType.json +23 -0
- package/dist/es/schemas/JsonLdContainerTypeArray.json +166 -0
- package/dist/es/schemas/JsonLdContextDefinition.json +134 -0
- package/dist/es/schemas/JsonLdContextDefinitionElement.json +17 -0
- package/dist/es/schemas/JsonLdContextDefinitionRoot.json +17 -0
- package/dist/es/schemas/JsonLdDocument.json +48 -0
- package/dist/es/schemas/JsonLdExpandedTermDefinition.json +148 -0
- package/dist/es/schemas/JsonLdGraphObject.json +44 -0
- package/dist/es/schemas/JsonLdIdMap.json +10 -0
- package/dist/es/schemas/JsonLdIncludedBlock.json +17 -0
- package/dist/es/schemas/JsonLdIndexMap.json +20 -0
- package/dist/es/schemas/JsonLdIndexMapItem.json +32 -0
- package/dist/es/schemas/JsonLdJsonArray.json +10 -0
- package/dist/es/schemas/JsonLdJsonObject.json +10 -0
- package/dist/es/schemas/JsonLdJsonPrimitive.json +20 -0
- package/dist/es/schemas/JsonLdJsonValue.json +17 -0
- package/dist/es/schemas/JsonLdLanguageMap.json +23 -0
- package/dist/es/schemas/JsonLdListObject.json +28 -0
- package/dist/es/schemas/JsonLdListOrSetItem.json +26 -0
- package/dist/es/schemas/JsonLdNodeObject.json +40 -0
- package/dist/es/schemas/JsonLdNodePrimitive.json +35 -0
- package/dist/es/schemas/JsonLdObject.json +76 -0
- package/dist/es/schemas/JsonLdSetObject.json +28 -0
- package/dist/es/schemas/JsonLdTypeMap.json +17 -0
- package/dist/es/schemas/JsonLdValueObject.json +125 -0
- package/dist/es/utils/jsonLdHelper.js +301 -0
- package/dist/es/utils/jsonLdHelper.js.map +1 -0
- package/dist/es/utils/jsonLdProcessor.js +507 -0
- package/dist/es/utils/jsonLdProcessor.js.map +1 -0
- package/dist/types/compiled/validators.d.ts +101 -0
- package/dist/types/dataTypes/jsonLdDataTypes.d.ts +9 -0
- package/dist/types/helpers/jsonLdAliasKey.d.ts +4 -0
- package/dist/types/helpers/jsonLdExistingProperty.d.ts +6 -0
- package/dist/types/helpers/jsonLdExistingPropertyEither.d.ts +6 -0
- package/dist/types/helpers/jsonLdKeys.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithAliases.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithAtId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithAtType.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithContext.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithNoAtId.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithNoAtType.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithNoContext.d.ts +5 -0
- package/dist/types/helpers/jsonLdObjectWithNoId.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithNoType.d.ts +4 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalAtId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalAtType.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalContext.d.ts +9 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalId.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithOptionalType.d.ts +7 -0
- package/dist/types/helpers/jsonLdObjectWithType.d.ts +7 -0
- package/dist/types/helpers/jsonLdOptionalKeys.d.ts +6 -0
- package/dist/types/helpers/jsonLdRequiredKeys.d.ts +5 -0
- package/dist/types/helpers/jsonLdWithAliases.d.ts +13 -0
- package/dist/types/index.d.ts +54 -0
- package/dist/types/models/IJsonLdContainerType.d.ts +8 -0
- package/dist/types/models/IJsonLdContainerTypeArray.d.ts +9 -0
- package/dist/types/models/IJsonLdContextDefinition.d.ts +24 -0
- package/dist/types/models/IJsonLdContextDefinitionElement.d.ts +9 -0
- package/dist/types/models/IJsonLdContextDefinitionRoot.d.ts +9 -0
- package/dist/types/models/IJsonLdDocument.d.ts +17 -0
- package/dist/types/models/IJsonLdExpandedTermDefinition.d.ts +29 -0
- package/dist/types/models/IJsonLdGraphObject.d.ts +16 -0
- package/dist/types/models/IJsonLdIdMap.d.ts +12 -0
- package/dist/types/models/IJsonLdIncludedBlock.d.ts +10 -0
- package/dist/types/models/IJsonLdIndexMap.d.ts +13 -0
- package/dist/types/models/IJsonLdIndexMapItem.d.ts +12 -0
- package/dist/types/models/IJsonLdJsonArray.d.ts +9 -0
- package/dist/types/models/IJsonLdJsonObject.d.ts +11 -0
- package/dist/types/models/IJsonLdJsonPrimitive.d.ts +8 -0
- package/dist/types/models/IJsonLdJsonValue.d.ts +11 -0
- package/dist/types/models/IJsonLdLanguageMap.d.ts +11 -0
- package/dist/types/models/IJsonLdListObject.d.ts +13 -0
- package/dist/types/models/IJsonLdListOrSetItem.d.ts +10 -0
- package/dist/types/models/IJsonLdNodeObject.d.ts +19 -0
- package/dist/types/models/IJsonLdNodePrimitive.d.ts +13 -0
- package/dist/types/models/IJsonLdObject.d.ts +25 -0
- package/dist/types/models/IJsonLdSetObject.d.ts +13 -0
- package/dist/types/models/IJsonLdTypeMap.d.ts +12 -0
- package/dist/types/models/IJsonLdValueObject.d.ts +26 -0
- package/dist/types/models/jsonLdContexts.d.ts +21 -0
- package/dist/types/models/jsonLdTypes.d.ts +113 -0
- package/dist/types/utils/jsonLdHelper.d.ts +97 -0
- package/dist/types/utils/jsonLdProcessor.d.ts +117 -0
- package/docs/changelog.md +15 -0
- package/docs/examples.md +214 -0
- package/docs/reference/classes/JsonLdDataTypes.md +25 -0
- package/docs/reference/classes/JsonLdHelper.md +371 -0
- package/docs/reference/classes/JsonLdProcessor.md +400 -0
- package/docs/reference/index.md +93 -0
- package/docs/reference/interfaces/IJsonLdContextDefinition.md +73 -0
- package/docs/reference/interfaces/IJsonLdGraphObject.md +31 -0
- package/docs/reference/interfaces/IJsonLdIdMap.md +11 -0
- package/docs/reference/interfaces/IJsonLdIndexMap.md +12 -0
- package/docs/reference/interfaces/IJsonLdJsonObject.md +7 -0
- package/docs/reference/interfaces/IJsonLdLanguageMap.md +11 -0
- package/docs/reference/interfaces/IJsonLdListObject.md +19 -0
- package/docs/reference/interfaces/IJsonLdNodeObject.md +100 -0
- package/docs/reference/interfaces/IJsonLdObject.md +64 -0
- package/docs/reference/interfaces/IJsonLdSetObject.md +19 -0
- package/docs/reference/interfaces/IJsonLdTypeMap.md +11 -0
- package/docs/reference/type-aliases/IJsonLdContainerType.md +5 -0
- package/docs/reference/type-aliases/IJsonLdContainerTypeArray.md +5 -0
- package/docs/reference/type-aliases/IJsonLdContextDefinitionElement.md +5 -0
- package/docs/reference/type-aliases/IJsonLdContextDefinitionRoot.md +5 -0
- package/docs/reference/type-aliases/IJsonLdDocument.md +11 -0
- package/docs/reference/type-aliases/IJsonLdExpandedTermDefinition.md +41 -0
- package/docs/reference/type-aliases/IJsonLdIncludedBlock.md +9 -0
- package/docs/reference/type-aliases/IJsonLdIndexMapItem.md +5 -0
- package/docs/reference/type-aliases/IJsonLdJsonArray.md +5 -0
- package/docs/reference/type-aliases/IJsonLdJsonPrimitive.md +5 -0
- package/docs/reference/type-aliases/IJsonLdJsonValue.md +5 -0
- package/docs/reference/type-aliases/IJsonLdListOrSetItem.md +5 -0
- package/docs/reference/type-aliases/IJsonLdNodePrimitive.md +5 -0
- package/docs/reference/type-aliases/IJsonLdValueObject.md +20 -0
- package/docs/reference/type-aliases/JsonLdAliasKey.md +15 -0
- package/docs/reference/type-aliases/JsonLdContexts.md +5 -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/JsonLdTypes.md +5 -0
- package/docs/reference/type-aliases/JsonLdWithAliases.md +17 -0
- package/docs/reference/variables/CompiledJsonLdContainerType.md +5 -0
- package/docs/reference/variables/CompiledJsonLdContainerTypeArray.md +5 -0
- package/docs/reference/variables/CompiledJsonLdContextDefinition.md +5 -0
- package/docs/reference/variables/CompiledJsonLdContextDefinitionElement.md +5 -0
- package/docs/reference/variables/CompiledJsonLdContextDefinitionRoot.md +5 -0
- package/docs/reference/variables/CompiledJsonLdDocument.md +5 -0
- package/docs/reference/variables/CompiledJsonLdExpandedTermDefinition.md +5 -0
- package/docs/reference/variables/CompiledJsonLdGraphObject.md +5 -0
- package/docs/reference/variables/CompiledJsonLdIdMap.md +5 -0
- package/docs/reference/variables/CompiledJsonLdIncludedBlock.md +5 -0
- package/docs/reference/variables/CompiledJsonLdIndexMap.md +5 -0
- package/docs/reference/variables/CompiledJsonLdIndexMapItem.md +5 -0
- package/docs/reference/variables/CompiledJsonLdJsonArray.md +5 -0
- package/docs/reference/variables/CompiledJsonLdJsonObject.md +5 -0
- package/docs/reference/variables/CompiledJsonLdJsonPrimitive.md +5 -0
- package/docs/reference/variables/CompiledJsonLdJsonValue.md +5 -0
- package/docs/reference/variables/CompiledJsonLdLanguageMap.md +5 -0
- package/docs/reference/variables/CompiledJsonLdListObject.md +5 -0
- package/docs/reference/variables/CompiledJsonLdListOrSetItem.md +5 -0
- package/docs/reference/variables/CompiledJsonLdNodeObject.md +5 -0
- package/docs/reference/variables/CompiledJsonLdNodePrimitive.md +5 -0
- package/docs/reference/variables/CompiledJsonLdObject.md +5 -0
- package/docs/reference/variables/CompiledJsonLdSetObject.md +5 -0
- package/docs/reference/variables/CompiledJsonLdTypeMap.md +5 -0
- package/docs/reference/variables/CompiledJsonLdValueObject.md +5 -0
- package/docs/reference/variables/JsonLdContexts.md +25 -0
- package/docs/reference/variables/JsonLdTypes.md +163 -0
- package/locales/.validate-ignore +1 -0
- package/locales/en.json +11 -0
- package/package.json +52 -5
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Interface: IJsonLdNodeObject
|
|
2
|
+
|
|
3
|
+
A node object represents zero or more properties of a node
|
|
4
|
+
in the graph serialized by the JSON-LD document.
|
|
5
|
+
|
|
6
|
+
## See
|
|
7
|
+
|
|
8
|
+
https://www.w3.org/TR/json-ld11/#node-objects
|
|
9
|
+
|
|
10
|
+
## Extends
|
|
11
|
+
|
|
12
|
+
- [`IJsonLdObject`](IJsonLdObject.md)
|
|
13
|
+
|
|
14
|
+
## Indexable
|
|
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`
|
|
17
|
+
|
|
18
|
+
## Properties
|
|
19
|
+
|
|
20
|
+
### @context? {#context}
|
|
21
|
+
|
|
22
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
23
|
+
|
|
24
|
+
#### Inherited from
|
|
25
|
+
|
|
26
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@context`](IJsonLdObject.md#context)
|
|
27
|
+
|
|
28
|
+
***
|
|
29
|
+
|
|
30
|
+
### @id? {#id}
|
|
31
|
+
|
|
32
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
33
|
+
|
|
34
|
+
#### Inherited from
|
|
35
|
+
|
|
36
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@id`](IJsonLdObject.md#id)
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### @included? {#included}
|
|
41
|
+
|
|
42
|
+
> `optional` **@included?**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
|
|
43
|
+
|
|
44
|
+
#### Inherited from
|
|
45
|
+
|
|
46
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@included`](IJsonLdObject.md#included)
|
|
47
|
+
|
|
48
|
+
***
|
|
49
|
+
|
|
50
|
+
### @graph? {#graph}
|
|
51
|
+
|
|
52
|
+
> `optional` **@graph?**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
|
|
53
|
+
|
|
54
|
+
#### Inherited from
|
|
55
|
+
|
|
56
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@graph`](IJsonLdObject.md#graph)
|
|
57
|
+
|
|
58
|
+
***
|
|
59
|
+
|
|
60
|
+
### @nest? {#nest}
|
|
61
|
+
|
|
62
|
+
> `optional` **@nest?**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
|
|
63
|
+
|
|
64
|
+
#### Inherited from
|
|
65
|
+
|
|
66
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@nest`](IJsonLdObject.md#nest)
|
|
67
|
+
|
|
68
|
+
***
|
|
69
|
+
|
|
70
|
+
### @type? {#type}
|
|
71
|
+
|
|
72
|
+
> `optional` **@type?**: `string` \| `string`[]
|
|
73
|
+
|
|
74
|
+
#### Inherited from
|
|
75
|
+
|
|
76
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@type`](IJsonLdObject.md#type)
|
|
77
|
+
|
|
78
|
+
***
|
|
79
|
+
|
|
80
|
+
### @reverse? {#reverse}
|
|
81
|
+
|
|
82
|
+
> `optional` **@reverse?**: `object`
|
|
83
|
+
|
|
84
|
+
#### Index Signature
|
|
85
|
+
|
|
86
|
+
\[`key`: `string`\]: `string`
|
|
87
|
+
|
|
88
|
+
#### Inherited from
|
|
89
|
+
|
|
90
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@reverse`](IJsonLdObject.md#reverse)
|
|
91
|
+
|
|
92
|
+
***
|
|
93
|
+
|
|
94
|
+
### @index? {#index}
|
|
95
|
+
|
|
96
|
+
> `optional` **@index?**: `string`
|
|
97
|
+
|
|
98
|
+
#### Inherited from
|
|
99
|
+
|
|
100
|
+
[`IJsonLdObject`](IJsonLdObject.md).[`@index`](IJsonLdObject.md#index)
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Interface: IJsonLdObject
|
|
2
|
+
|
|
3
|
+
An object represents the pre-defined properties of the node object
|
|
4
|
+
in the graph serialized by the JSON-LD document.
|
|
5
|
+
|
|
6
|
+
## See
|
|
7
|
+
|
|
8
|
+
https://www.w3.org/TR/json-ld11/#node-objects
|
|
9
|
+
|
|
10
|
+
## Extended by
|
|
11
|
+
|
|
12
|
+
- [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### @context? {#context}
|
|
17
|
+
|
|
18
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](../type-aliases/IJsonLdContextDefinitionRoot.md)
|
|
19
|
+
|
|
20
|
+
***
|
|
21
|
+
|
|
22
|
+
### @id? {#id}
|
|
23
|
+
|
|
24
|
+
> `optional` **@id?**: `string` \| `string`[]
|
|
25
|
+
|
|
26
|
+
***
|
|
27
|
+
|
|
28
|
+
### @included? {#included}
|
|
29
|
+
|
|
30
|
+
> `optional` **@included?**: [`IJsonLdIncludedBlock`](../type-aliases/IJsonLdIncludedBlock.md)
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### @graph? {#graph}
|
|
35
|
+
|
|
36
|
+
> `optional` **@graph?**: [`IJsonLdNodeObject`](IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)[]
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### @nest? {#nest}
|
|
41
|
+
|
|
42
|
+
> `optional` **@nest?**: [`IJsonLdJsonObject`](IJsonLdJsonObject.md) \| [`IJsonLdJsonObject`](IJsonLdJsonObject.md)[]
|
|
43
|
+
|
|
44
|
+
***
|
|
45
|
+
|
|
46
|
+
### @type? {#type}
|
|
47
|
+
|
|
48
|
+
> `optional` **@type?**: `string` \| `string`[]
|
|
49
|
+
|
|
50
|
+
***
|
|
51
|
+
|
|
52
|
+
### @reverse? {#reverse}
|
|
53
|
+
|
|
54
|
+
> `optional` **@reverse?**: `object`
|
|
55
|
+
|
|
56
|
+
#### Index Signature
|
|
57
|
+
|
|
58
|
+
\[`key`: `string`\]: `string`
|
|
59
|
+
|
|
60
|
+
***
|
|
61
|
+
|
|
62
|
+
### @index? {#index}
|
|
63
|
+
|
|
64
|
+
> `optional` **@index?**: `string`
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Interface: IJsonLdSetObject
|
|
2
|
+
|
|
3
|
+
A set represents an unordered set of values.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://www.w3.org/TR/json-ld11/#lists-and-sets
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### @set {#set}
|
|
12
|
+
|
|
13
|
+
> **@set**: [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md) \| [`IJsonLdListOrSetItem`](../type-aliases/IJsonLdListOrSetItem.md)[]
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### @index? {#index}
|
|
18
|
+
|
|
19
|
+
> `optional` **@index?**: `string`
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Interface: IJsonLdTypeMap
|
|
2
|
+
|
|
3
|
+
A type map is used to associate an IRI with a value that allows easy programmatic access.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://www.w3.org/TR/json-ld11/#type-maps
|
|
8
|
+
|
|
9
|
+
## Indexable
|
|
10
|
+
|
|
11
|
+
> \[`key`: `string`\]: `string` \| [`IJsonLdNodeObject`](IJsonLdNodeObject.md)
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: IJsonLdContainerTypeArray
|
|
2
|
+
|
|
3
|
+
> **IJsonLdContainerTypeArray** = \[`"@graph"`, `"@id"`\] \| \[`"@id"`, `"@graph"`\] \| \[`"@set"`, `"@graph"`, `"@id"`\] \| \[`"@set"`, `"@id"`, `"@graph"`\] \| \[`"@graph"`, `"@set"`, `"@id"`\] \| \[`"@id"`, `"@set"`, `"@graph"`\] \| \[`"@graph"`, `"@id"`, `"@set"`\] \| \[`"@id"`, `"@graph"`, `"@set"`\] \| \[`"@set"`, [`IJsonLdContainerType`](IJsonLdContainerType.md)\] \| \[[`IJsonLdContainerType`](IJsonLdContainerType.md), `"@set"`\]
|
|
4
|
+
|
|
5
|
+
JSON-LD container type array.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: IJsonLdContextDefinitionRoot
|
|
2
|
+
|
|
3
|
+
> **IJsonLdContextDefinitionRoot** = [`IJsonLdContextDefinitionElement`](IJsonLdContextDefinitionElement.md) \| [`IJsonLdContextDefinitionElement`](IJsonLdContextDefinitionElement.md)[]
|
|
4
|
+
|
|
5
|
+
A context definition root is used to define the root of a context definition.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Type Alias: IJsonLdDocument
|
|
2
|
+
|
|
3
|
+
> **IJsonLdDocument** = [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[] \| \{ `@context?`: [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md); `@graph?`: [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| ([`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md))[]; \}
|
|
4
|
+
|
|
5
|
+
A JSON-LD document MUST be valid JSON text as described in [RFC8259],
|
|
6
|
+
or some format that can be represented in the JSON-LD internal representation
|
|
7
|
+
that is equivalent to valid JSON text.
|
|
8
|
+
|
|
9
|
+
## See
|
|
10
|
+
|
|
11
|
+
https://www.w3.org/TR/json-ld11/#json-ld-grammar
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Type Alias: IJsonLdExpandedTermDefinition
|
|
2
|
+
|
|
3
|
+
> **IJsonLdExpandedTermDefinition** = `object` & \{ `@id?`: `string` \| `string`[] \| `null`; `@nest?`: `"@nest"` \| `string`; `@container?`: `"@list"` \| `"@set"` \| [`IJsonLdContainerType`](IJsonLdContainerType.md) \| (`"@list"` \| `"@set"` \| [`IJsonLdContainerType`](IJsonLdContainerType.md))[] \| [`IJsonLdContainerTypeArray`](IJsonLdContainerTypeArray.md) \| `null`; \} \| \{ `@reverse`: `string`; `@container?`: `"@set"` \| `"@index"` \| `null`; \}
|
|
4
|
+
|
|
5
|
+
An expanded term definition is used to describe the mapping between a term
|
|
6
|
+
and its expanded identifier, as well as other properties of the value
|
|
7
|
+
associated with the term when it is used as key in a node object.
|
|
8
|
+
|
|
9
|
+
## Type Declaration
|
|
10
|
+
|
|
11
|
+
### @type?
|
|
12
|
+
|
|
13
|
+
> `optional` **@type?**: `"@id"` \| `"@json"` \| `"@none"` \| `"@vocab"` \| `string`
|
|
14
|
+
|
|
15
|
+
### @language?
|
|
16
|
+
|
|
17
|
+
> `optional` **@language?**: `string`
|
|
18
|
+
|
|
19
|
+
### @index?
|
|
20
|
+
|
|
21
|
+
> `optional` **@index?**: `string`
|
|
22
|
+
|
|
23
|
+
### @context?
|
|
24
|
+
|
|
25
|
+
> `optional` **@context?**: [`IJsonLdContextDefinition`](../interfaces/IJsonLdContextDefinition.md)
|
|
26
|
+
|
|
27
|
+
### @prefix?
|
|
28
|
+
|
|
29
|
+
> `optional` **@prefix?**: `boolean`
|
|
30
|
+
|
|
31
|
+
### @propagate?
|
|
32
|
+
|
|
33
|
+
> `optional` **@propagate?**: `boolean`
|
|
34
|
+
|
|
35
|
+
### @protected?
|
|
36
|
+
|
|
37
|
+
> `optional` **@protected?**: `boolean`
|
|
38
|
+
|
|
39
|
+
## See
|
|
40
|
+
|
|
41
|
+
https://www.w3.org/TR/json-ld11/#expanded-term-definition
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Type Alias: IJsonLdIncludedBlock
|
|
2
|
+
|
|
3
|
+
> **IJsonLdIncludedBlock** = [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md)[]
|
|
4
|
+
|
|
5
|
+
An included block is used to provide a set of node objects.
|
|
6
|
+
|
|
7
|
+
## See
|
|
8
|
+
|
|
9
|
+
https://www.w3.org/TR/json-ld11/#included-blocks
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: IJsonLdIndexMapItem
|
|
2
|
+
|
|
3
|
+
> **IJsonLdIndexMapItem** = `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdListObject`](../interfaces/IJsonLdListObject.md) \| [`IJsonLdSetObject`](../interfaces/IJsonLdSetObject.md)
|
|
4
|
+
|
|
5
|
+
The items that can be stored in an index map.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: IJsonLdListOrSetItem
|
|
2
|
+
|
|
3
|
+
> **IJsonLdListOrSetItem** = `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md)
|
|
4
|
+
|
|
5
|
+
A list or set item can be a null, boolean, number, string, node object, or value object.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
# Type Alias: IJsonLdNodePrimitive
|
|
2
|
+
|
|
3
|
+
> **IJsonLdNodePrimitive** = `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdNodeObject`](../interfaces/IJsonLdNodeObject.md) \| [`IJsonLdGraphObject`](../interfaces/IJsonLdGraphObject.md) \| [`IJsonLdValueObject`](IJsonLdValueObject.md) \| [`IJsonLdListObject`](../interfaces/IJsonLdListObject.md) \| [`IJsonLdSetObject`](../interfaces/IJsonLdSetObject.md)
|
|
4
|
+
|
|
5
|
+
A node primitive is a JSON-LD value which is not one of the defined NodeObject properties.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Type Alias: IJsonLdValueObject
|
|
2
|
+
|
|
3
|
+
> **IJsonLdValueObject** = `object` & \{ `@value`: `null` \| `boolean` \| `number` \| `string`; `@language?`: `string`; `@direction?`: `"ltr"` \| `"rtl"` \| `null`; \} \| \{ `@value`: `null` \| `boolean` \| `number` \| `string`; `@type`: `string`; \} \| \{ `@value`: `null` \| `boolean` \| `number` \| `string` \| [`IJsonLdJsonObject`](../interfaces/IJsonLdJsonObject.md) \| [`IJsonLdJsonArray`](IJsonLdJsonArray.md); `@type`: `"@json"`; \}
|
|
4
|
+
|
|
5
|
+
A value object is used to explicitly associate a type or a language with a value
|
|
6
|
+
to create a typed value or a language-tagged string and possibly associate a base direction.
|
|
7
|
+
|
|
8
|
+
## Type Declaration
|
|
9
|
+
|
|
10
|
+
### @index?
|
|
11
|
+
|
|
12
|
+
> `optional` **@index?**: `string`
|
|
13
|
+
|
|
14
|
+
### @context?
|
|
15
|
+
|
|
16
|
+
> `optional` **@context?**: [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)
|
|
17
|
+
|
|
18
|
+
## See
|
|
19
|
+
|
|
20
|
+
https://www.w3.org/TR/json-ld11/#value-objects
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Type Alias: JsonLdAliasKey\<K, Prefix\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdAliasKey**\<`K`, `Prefix`\> = `K` *extends* `` `@${string}` `` ? `K` : `` `${Prefix}:${K}` ``
|
|
4
|
+
|
|
5
|
+
Keep JSON-LD keys as-is and prefix non-JSON-LD keys.
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### K
|
|
10
|
+
|
|
11
|
+
`K` *extends* `string`
|
|
12
|
+
|
|
13
|
+
### Prefix
|
|
14
|
+
|
|
15
|
+
`Prefix` *extends* `string`
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Type Alias: JsonLdExistingProperty\<T, P, D\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdExistingProperty**\<`T`, `P`, `D`\> = `T` *extends* `{ [K in P]?: infer PropertyType }` ? `Exclude`\<`PropertyType`, `undefined`\> : `D`
|
|
4
|
+
|
|
5
|
+
Infer an existing property's type from a source type, or fall back to a default.
|
|
6
|
+
|
|
7
|
+
## Type Parameters
|
|
8
|
+
|
|
9
|
+
### T
|
|
10
|
+
|
|
11
|
+
`T` *extends* `object`
|
|
12
|
+
|
|
13
|
+
### P
|
|
14
|
+
|
|
15
|
+
`P` *extends* `PropertyKey`
|
|
16
|
+
|
|
17
|
+
### D
|
|
18
|
+
|
|
19
|
+
`D`
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Type Alias: JsonLdExistingPropertyEither\<T, P1, P2, D\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdExistingPropertyEither**\<`T`, `P1`, `P2`, `D`\> = \[[`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P1`, `never`\> \| [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P2`, `never`\>\] *extends* \[`never`\] ? `D` : [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P1`, `never`\> \| [`JsonLdExistingProperty`](JsonLdExistingProperty.md)\<`T`, `P2`, `never`\>
|
|
4
|
+
|
|
5
|
+
Infer an existing property's type from either of two source properties,
|
|
6
|
+
or fall back to a default when neither exists.
|
|
7
|
+
|
|
8
|
+
## Type Parameters
|
|
9
|
+
|
|
10
|
+
### T
|
|
11
|
+
|
|
12
|
+
`T` *extends* `object`
|
|
13
|
+
|
|
14
|
+
### P1
|
|
15
|
+
|
|
16
|
+
`P1` *extends* `PropertyKey`
|
|
17
|
+
|
|
18
|
+
### P2
|
|
19
|
+
|
|
20
|
+
`P2` *extends* `PropertyKey`
|
|
21
|
+
|
|
22
|
+
### D
|
|
23
|
+
|
|
24
|
+
`D`
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithAliases\<T, Prefix\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithAliases**\<`T`, `Prefix`\> = [`JsonLdKeys`](JsonLdKeys.md)\<`T`\> & [`JsonLdWithAliases`](JsonLdWithAliases.md)\<`T`, `Prefix`\>
|
|
4
|
+
|
|
5
|
+
Create a JSON-LD object shape containing only JSON-LD keys plus aliased
|
|
6
|
+
non-JSON-LD keys.
|
|
7
|
+
|
|
8
|
+
## Type Parameters
|
|
9
|
+
|
|
10
|
+
### T
|
|
11
|
+
|
|
12
|
+
`T` *extends* `object`
|
|
13
|
+
|
|
14
|
+
### Prefix
|
|
15
|
+
|
|
16
|
+
`Prefix` *extends* `string`
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithAtId\<T, Id\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithAtId**\<`T`, `Id`\> = `Omit`\<`T`, `"@id"` \| `"id"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "@id" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @id
|
|
10
|
+
|
|
11
|
+
> **@id**: `Id`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Id
|
|
20
|
+
|
|
21
|
+
`Id` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"@id"`, `"id"`, `string`\>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithAtType\<T, Ty\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithAtType**\<`T`, `Ty`\> = `Omit`\<`T`, `"@type"` \| `"type"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "@type" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @type
|
|
10
|
+
|
|
11
|
+
> **@type**: `Ty`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Ty
|
|
20
|
+
|
|
21
|
+
`Ty` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"@type"`, `"type"`, `string` \| `string`[]\>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithContext\<T, C\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithContext**\<`T`, `C`\> = `Omit`\<`T`, `"@context"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "@context" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @context
|
|
10
|
+
|
|
11
|
+
> **@context**: `C`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### C
|
|
20
|
+
|
|
21
|
+
`C` = [`IJsonLdContextDefinitionRoot`](IJsonLdContextDefinitionRoot.md)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithId\<T, Id\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithId**\<`T`, `Id`\> = `Omit`\<`T`, `"id"` \| `"@id"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add "id" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### id
|
|
10
|
+
|
|
11
|
+
> **id**: `Id`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Id
|
|
20
|
+
|
|
21
|
+
`Id` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"id"`, `"@id"`, `string`\>
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithNoContext\<T\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithNoContext**\<`T`\> = `Omit`\<`T`, `"@context"`\>
|
|
4
|
+
|
|
5
|
+
Omit optional "@context" from a type, inferring an existing context type from
|
|
6
|
+
the source type when available, otherwise using the provided default.
|
|
7
|
+
|
|
8
|
+
## Type Parameters
|
|
9
|
+
|
|
10
|
+
### T
|
|
11
|
+
|
|
12
|
+
`T` *extends* `object`
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithOptionalAtId\<T, Id\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithOptionalAtId**\<`T`, `Id`\> = `Omit`\<`T`, `"@id"` \| `"id"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add optional "@id" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @id?
|
|
10
|
+
|
|
11
|
+
> `optional` **@id?**: `Id`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Id
|
|
20
|
+
|
|
21
|
+
`Id` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"@id"`, `"id"`, `string`\>
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Type Alias: JsonLdObjectWithOptionalAtType\<T, Ty\>
|
|
2
|
+
|
|
3
|
+
> **JsonLdObjectWithOptionalAtType**\<`T`, `Ty`\> = `Omit`\<`T`, `"@type"` \| `"type"`\> & `object`
|
|
4
|
+
|
|
5
|
+
Add optional "@type" to a type.
|
|
6
|
+
|
|
7
|
+
## Type Declaration
|
|
8
|
+
|
|
9
|
+
### @type?
|
|
10
|
+
|
|
11
|
+
> `optional` **@type?**: `Ty`
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` *extends* `object`
|
|
18
|
+
|
|
19
|
+
### Ty
|
|
20
|
+
|
|
21
|
+
`Ty` = [`JsonLdExistingPropertyEither`](JsonLdExistingPropertyEither.md)\<`T`, `"@type"`, `"type"`, `string` \| `string`[]\>
|