Skip to content
This repository has been archived by the owner on Oct 1, 2023. It is now read-only.

Latest commit

 

History

History
218 lines (127 loc) · 6.04 KB

modules.md

File metadata and controls

218 lines (127 loc) · 6.04 KB
Raw

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

Type parameters

Name Type
InAndOutQuad extends BaseQuad = BaseQuad

Type declaration

▸ (dataset, changes): void

An event listeners for nodes

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

void

Defined in

lib/types.ts:24

Functions

createDataset

▸ createDataset(quads?): ExtendedDataset<Quad>

Creates an ExtendedDataset

Parameters

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

Returns

ExtendedDataset<Quad>

Dataset

createDatasetFactory

▸ createDatasetFactory(): ExtendedDatasetFactory<Quad>

Creates a dataset factory that generates ExtendedDatasets

Returns

ExtendedDatasetFactory<Quad>

DatasetFactory

createDatasetFromSerializedInput

▸ createDatasetFromSerializedInput<ReturnDataset>(datasetFactory, data, options?): 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
ReturnDataset extends Dataset<Quad, Quad, ReturnDataset> = Dataset<Quad, Quad>

Parameters

Name Type Description
datasetFactory DatasetFactory<Quad, Quad, Dataset<Quad, 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

createSubscribableDataset

▸ createSubscribableDataset(quads?): WrapperSubscribableDataset<Quad>

Creates a SubscribableDataset

Parameters

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

Returns

WrapperSubscribableDataset<Quad>

Dataset

createSubscribableDatasetFactory

▸ createSubscribableDatasetFactory(): WrapperSubscribableDatasetFactory<Quad>

Creates a dataset factory that generates a SubscribableDataset

Returns

WrapperSubscribableDatasetFactory<Quad>

DatasetFactory for SubscribableDataset

serializedToDataset

▸ serializedToDataset(data, options?): 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

serializedToSubscribableDataset

▸ serializedToSubscribableDataset(data, options?): 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