tripledoc v4.4.0

tripledoc

Read, create and edit Turtle documents on Solid Pods.

Installation

npm install tripledoc

Usage

// TODO

Changelog

See CHANGELOG.

License

MIT © Vincent Tunru

API

Index

Type aliases

• DeleteStatementsFromStore
• GetEntitiesFromStore
• GetEntityFromStore

Variables

• fetcher
• store
• updater

Functions

• createDocument
• deleteStatementsFromStore
• fetchDocument
• getEntitiesFromStore
• getEntityFromStore
• getFetcher
• getObjectFromStore
• getObjectsFromStore
• getPredicateFromStore
• getPredicatesFromStore
• getStore
• getSubjectFromStore
• getSubjectsFromStore
• getUpdater
• withStorePlural
• withStoreSingular

Type aliases

DeleteStatementsFromStore

Ƭ DeleteStatementsFromStore: function

Defined in deleteStatements.ts:3

Type declaration:

▸ (store: IndexedFormula, updater: UpdateManager, statements: Statement[]): Promise<Statement[]>

Parameters:

GetEntitiesFromStore

Ƭ GetEntitiesFromStore: function

Defined in getEntities.ts:9

Type declaration:

▸ (store: IndexedFormula, knownEntity1: NamedNode, knownEntity2: NamedNode, document: NamedNode): Node[]

Parameters:

GetEntityFromStore

Ƭ GetEntityFromStore: function

Defined in getEntities.ts:3

Type declaration:

▸ (store: IndexedFormula, knownEntity1: NamedNode, knownEntity2: NamedNode, document: NamedNode): Node

Parameters:

Variables

Const fetcher

• fetcher: Fetcher = new $rdf.Fetcher(store, undefined)

Defined in store.ts:4

Const store

• store: IndexedFormula = $rdf.graph()

Defined in store.ts:3

Const updater

• updater: UpdateManager = new $rdf.UpdateManager(store)

Defined in store.ts:5

Functions

createDocument

▸ createDocument(url: string, statements: Statement[]): Promise<void>

Defined in document.ts:13

Initialise a new Turtle document

Parameters:

Returns: Promise<void>

Const deleteStatementsFromStore

▸ deleteStatementsFromStore(store: IndexedFormula, updater: UpdateManager, statements: Statement[]): Promise<Statement[]>

Defined in deleteStatements.ts:9

Parameters:

Returns: Promise<Statement[]>

fetchDocument

▸ fetchDocument(uri: string): Promise<object>

Defined in document.ts:26

Retrieve a document containing RDF triples

Parameters:

Returns: Promise<object>

Representation of triples in the document at uri

getEntitiesFromStore

▸ getEntitiesFromStore(store: IndexedFormula, type: "subject" | "predicate" | "object", subject: null | NamedNode, predicate: null | NamedNode, object: null | NamedNode, document: null | NamedNode): Node[]

Defined in getEntities.ts:49

Parameters:

Returns: Node[]

getEntityFromStore

▸ getEntityFromStore(store: IndexedFormula, type: "subject" | "predicate" | "object", subject: null | NamedNode, predicate: null | NamedNode, object: null | NamedNode, document: null | NamedNode): Node

Defined in getEntities.ts:37

Parameters:

Returns: Node

getFetcher

▸ getFetcher(): Fetcher

Defined in store.ts:11

Returns: Fetcher

Const getObjectFromStore

▸ getObjectFromStore(store: IndexedFormula, subject: NamedNode, predicate: NamedNode, document: NamedNode): Node

Defined in getEntities.ts:30

Parameters:

Returns: Node

Const getObjectsFromStore

▸ getObjectsFromStore(store: IndexedFormula, subject: NamedNode, predicate: NamedNode, document: NamedNode): Node[]

Defined in getEntities.ts:33

Parameters:

Returns: Node[]

Const getPredicateFromStore

▸ getPredicateFromStore(store: IndexedFormula, subject: NamedNode, object: NamedNode, document: NamedNode): Node

Defined in getEntities.ts:23

Parameters:

Returns: Node

Const getPredicatesFromStore

▸ getPredicatesFromStore(store: IndexedFormula, subject: NamedNode, object: NamedNode, document: NamedNode): Node[]

Defined in getEntities.ts:26

Parameters:

Returns: Node[]

getStore

▸ getStore(): IndexedFormula

Defined in store.ts:7

Returns: IndexedFormula

Const getSubjectFromStore

▸ getSubjectFromStore(store: IndexedFormula, predicate: NamedNode, object: NamedNode, document: NamedNode): Node

Defined in getEntities.ts:16

Parameters:

Returns: Node

Const getSubjectsFromStore

▸ getSubjectsFromStore(store: IndexedFormula, predicate: NamedNode, object: NamedNode, document: NamedNode): Node[]

Defined in getEntities.ts:19

Parameters:

Returns: Node[]

getUpdater

▸ getUpdater(): UpdateManager

Defined in store.ts:15

Returns: UpdateManager

Const withStorePlural

▸ withStorePlural(getEntitiesFromStore: GetEntitiesFromStore, store: IndexedFormula): (Anonymous function)

Defined in document.ts:66

Parameters:

Returns: (Anonymous function)

Const withStoreSingular

▸ withStoreSingular(getEntityFromStore: GetEntityFromStore, store: IndexedFormula): (Anonymous function)

Defined in document.ts:62

Parameters:

Returns: (Anonymous function)