@manta-eu/rdf-lib/jsonld

Type Aliases

JsonLdContext

JsonLdContext = Record<string, string | { @id: string; @type?: string; }>

---

JsonLdDocument

JsonLdDocument = object & JsonLdNode

Type Declaration

@context?

optional @context?: JsonLdContext

@graph?

optional @graph?: JsonLdNode[]

---

JsonLdGraphDocument

JsonLdGraphDocument = JsonLdDocument & object

Type Declaration

@graph

@graph: JsonLdNode[]

---

JsonLdNode

JsonLdNode = object

Indexable

[key: string]: JsonLdValue | undefined

Properties

@id?

optional @id?: string

@language?

optional @language?: string

@type?

optional @type?: string | string[]

@value?

optional @value?: string | number | boolean

---

JsonLdValue

JsonLdValue = string | number | boolean | null | JsonLdNode | JsonLdValue[]

Functions

getJsonLdGraph()

getJsonLdGraph(doc): JsonLdNode[]

Parameters

doc

JsonLdDocument

Returns

JsonLdNode[]

---

getNodeId()

getNodeId(node): string | undefined

Parameters

node

JsonLdNode

Returns

string | undefined

---

getNodeType()

getNodeType(node): string | string[] | undefined

Parameters

node

JsonLdNode

Returns

string | string[] | undefined

---

getNodeTypes()

getNodeTypes(node): string[]

Parameters

node

JsonLdNode

Returns

string[]

---

getNumberValue()

getNumberValue(node, predicate): number | null

Parameters

node

JsonLdNode

predicate

string

Returns

number | null

---

getRefId()

getRefId(node, predicate): string | null

Parameters

node

JsonLdNode

predicate

string

Returns

string | null

---

getStringValue()

getStringValue(node, predicate): string | null

Parameters

node

JsonLdNode

predicate

string

Returns

string | null

---

hasType()

hasType(node, typeUri): boolean

Parameters

node

JsonLdNode

typeUri

string

Returns

boolean

---

isJsonLdDocument()

isJsonLdDocument(value): value is JsonLdDocument

Parameters

value

unknown

Returns

value is JsonLdDocument

---

isJsonLdGraphDocument()

isJsonLdGraphDocument(value): value is JsonLdGraphDocument

Parameters

value

unknown

Returns

value is JsonLdGraphDocument

---

isJsonLdNode()

isJsonLdNode(value): value is JsonLdNode

Parameters

value

unknown

Returns

value is JsonLdNode

---

mergeJsonLdGraphs()

mergeJsonLdGraphs(documents): JsonLdGraphDocument

Parameters

documents

JsonLdGraphDocument[]

Returns

JsonLdGraphDocument

---

mergeNodesById()

mergeNodesById(nodes): JsonLdNode[]

Parameters

nodes

JsonLdNode[]

Returns

JsonLdNode[]