Skip to content

Latest commit

 

History

History
212 lines (124 loc) · 7.35 KB

modules.md

File metadata and controls

212 lines (124 loc) · 7.35 KB

o-dataset-pack / Exports

o-dataset-pack

Table of contents

Classes

Interfaces

Type aliases

Functions

Type aliases

SubscribableTerms

Ƭ SubscribableTerms: NamedNode | BlankNode | DefaultGraph

Types of nodes a subscribable dataset can subscribe to

Defined in: lib/types.ts:19

nodeEventListener

Ƭ nodeEventListener<InAndOutQuad>: (dataset: Dataset<InAndOutQuad, InAndOutQuad>, changes: DatasetChanges<InAndOutQuad>) => void

An event listeners for nodes

Type parameters

Name Type Default
InAndOutQuad BaseQuad BaseQuad

Type declaration

▸ (dataset: Dataset<InAndOutQuad, InAndOutQuad>, changes: DatasetChanges<InAndOutQuad>): void

Parameters

Name Type
dataset Dataset<InAndOutQuad, InAndOutQuad>
changes DatasetChanges<InAndOutQuad>

Returns: void

Defined in: lib/types.ts:24

Functions

createDataset

▸ createDataset(quads?: Dataset<Quad> | Quad[]): ExtendedDataset<Quad>

Creates an ExtendedDataset

Parameters

Name Type
quads? Dataset<Quad> | Quad[]

Returns: ExtendedDataset<Quad>

Dataset

Defined in: lib/createExtendedDataset.ts:26

createDatasetFactory

▸ createDatasetFactory(): ExtendedDatasetFactory<Quad>

Creates a dataset factory that generates ExtendedDatasets

Returns: ExtendedDatasetFactory<Quad>

DatasetFactory

Defined in: lib/createExtendedDataset.ts:10

createDatasetFromSerializedInput

▸ createDatasetFromSerializedInput<ReturnDataset>(datasetFactory: DatasetFactory<Quad>, data: string, options?: ParserOptions): Promise<ReturnDataset>

Creates a dataset with a string input that could be SON-LD, Turtle, N-Triples, TriG, RDF*, or N3.

Type parameters

Name Type Default
ReturnDataset Dataset<Quad, Quad, ReturnDataset> Dataset<Quad, Quad>

Parameters

Name Type Description
datasetFactory DatasetFactory<Quad> A datasetFactory that will initialize a returned dataset.\
data string A string representation of RDF Data in JSON-LD, Turtle, N-Triples, TriG, RDF*, or N3.
options? ParserOptions Parser options: { format?: string; factory?: RDF.DataFactory; baseIRI?: string; blankNodePrefix?: string; }

Returns: Promise<ReturnDataset>

A dataset

Defined in: lib/createDatasetFromSerializedInput.ts:18

createSubscribableDataset

▸ createSubscribableDataset(quads?: Dataset<Quad> | Quad[]): WrapperSubscribableDataset<Quad>

Creates a SubscribableDataset

Parameters

Name Type
quads? Dataset<Quad> | Quad[]

Returns: WrapperSubscribableDataset<Quad>

Dataset

Defined in: lib/createWrapperSubscribableDataset.ts:24

createSubscribableDatasetFactory

▸ createSubscribableDatasetFactory(): WrapperSubscribableDatasetFactory<Quad>

Creates a dataset factory that generates a SubscribableDataset

Returns: WrapperSubscribableDatasetFactory<Quad>

DatasetFactory for SubscribableDataset

Defined in: lib/createWrapperSubscribableDataset.ts:10

serializedToDataset

▸ serializedToDataset(data: string, options?: ParserOptions): Promise<ExtendedDataset<Quad>>

Creates an ExtendedDataset with a string input that could be JSON-LD, Turtle, N-Triples, TriG, RDF*, or N3.

Parameters

Name Type Description
data string A string representation of RDF Data in JSON-LD, Turtle, N-Triples, TriG, RDF*, or N3.
options? ParserOptions Parser options: { format?: string; factory?: RDF.DataFactory; baseIRI?: string; blankNodePrefix?: string; }

Returns: Promise<ExtendedDataset<Quad>>

A dataset

Defined in: lib/createExtendedDatasetFromSerializedInput.ts:18

serializedToSubscribableDataset

▸ serializedToSubscribableDataset(data: string, options?: ParserOptions): Promise<WrapperSubscribableDataset<Quad>>

Creates a SubscribableDataset with a string input that could be JSON-LD, Turtle, N-Triples, TriG, RDF*, or N3.

Parameters

Name Type Description
data string A string representation of RDF Data in JSON-LD, Turtle, N-Triples, TriG, RDF*, or N3.
options? ParserOptions Parser options: { format?: string; factory?: RDF.DataFactory; baseIRI?: string; blankNodePrefix?: string; }

Returns: Promise<WrapperSubscribableDataset<Quad>>

A dataset

Defined in: lib/createWrapperSubscribableDatasetFromSerializedInput.ts:18