rdflib

References

IndexedFormula

Renames and re-exports Store

Namespace

Renames and re-exports __type

namedNode

Renames and re-exports sym

Properties

jsonParser

jsonParser: { parseJSON: (data: any, source: any, store: any) => void }

Type declaration

parseJSON: (data: any, source: any, store: any) => void
- - (data: any, source: any, store: any): void
  - Parameters
    - data: any
    - source: any
    - store: any
    Returns void

Variables

Const DataFactory

DataFactory: IRDFlibDataFactory = ...

Full RDFLib.js Data Factory

Const NextId

NextId: number = BlankNode.nextId

Const log

log: { debug: any; error: any; info: any; msg: any; success: any; warn: any } = ...

Type declaration

debug:function
- debug(x: any): void
- - Defined in src/log.js:6
  Parameters
  - x: any
  Returns void
error:function
- error(x: any): void
- - Defined in src/log.js:9
  Parameters
  - x: any
  Returns void
info:function
- info(x: any): void
- - Defined in src/log.js:8
  Parameters
  - x: any
  Returns void
msg:function
- msg(x: any): void
- - Defined in src/log.js:11
  Parameters
  - x: any
  Returns void
success:function
- success(x: any): void
- - Defined in src/log.js:10
  Parameters
  - x: any
  Returns void
warn:function
- warn(x: any): void
- - Defined in src/log.js:7
  Parameters
  - x: any
  Returns void

Functions

N3Parser

N3Parser(store: any, openFormula: any, thisDoc: any, baseURI: any, genPrefix: any, metaURI: any, flags: any, why: any): SinkParser

- Defined in src/n3parser.js:217
Parameters
- store: any
- openFormula: any
- thisDoc: any
- baseURI: any
- genPrefix: any
- metaURI: any
- flags: any
- why: any
Returns SinkParser

SPARQLToQuery

SPARQLToQuery(SPARQL: any, testMode: any, kb: any): false | Query

- Defined in src/sparql-to-query.js:19
sparql:
SPARQL text that is converted to a query object which is returned.

testmode:
testing flag. Prevents loading of sources.

Parameters
- SPARQL: any
- testMode: any
- kb: any
Returns false | Query

Serializer

Serializer(store: any): Serializer

- Defined in src/serializer.js:17
Parameters
- store: any
Returns Serializer

blankNode

blankNode(value?: string): BlankNode

- Defined in src/factories/factory-types.ts:70
Parameters
- Optional value: string
Returns BlankNode

defaultGraph

defaultGraph(): default

- Defined in src/factories/factory-types.ts:76
Returns default

fetcher

fetcher(store: Store, options: any): Fetcher

- Defined in src/types.ts:95
Parameters
- store: Store
- options: any
Returns Fetcher

fromNT

fromNT(str: any): any

- Defined in src/index.ts:56
Parameters
- str: any
Returns any

graph

graph(features?: any, opts?: any): Store

- Defined in src/types.ts:97
Parameters
- Optional features: any
- Optional opts: any
Returns Store

isBlankNode

isBlankNode(obj: any): obj is BlankNode

- Defined in src/utils/terms.ts:103
TypeGuard for RDF/JS spec BlankNodes

Parameters
- obj: any
Returns obj is BlankNode

isCollection

isCollection(obj: any): obj is Collection<any>

- Defined in src/utils/terms.ts:31
TypeGuard for RDFLib Collections

Parameters
- obj: any
Returns obj is Collection<any>

isGraph

isGraph(obj: any): obj is Quad_Graph

- Defined in src/utils/terms.ts:135
TypeGuard for valid RDF/JS Graph types

Parameters
- obj: any
Returns obj is Quad_Graph

isLiteral

isLiteral(value: any): value is Literal

- Defined in src/utils/terms.ts:84
TypeGuard for RDF/JS spec Literals

Parameters
- value: any
Returns value is Literal

isNamedNode

isNamedNode(obj: any): obj is NamedNode

- Defined in src/utils/terms.ts:98
TypeGuard for RDF/JS spec NamedNodes

Parameters
- obj: any
Returns obj is NamedNode

isPredicate

isPredicate(obj: any): obj is Quad_Predicate

- Defined in src/utils/terms.ts:117
TypeGuard for valid RDF/JS spec Predicate types

Parameters
- obj: any
Returns obj is Quad_Predicate

isQuad

isQuad(obj: any): obj is Quad<any, any, any, any>

- Defined in src/utils/terms.ts:89
TypeGuard for RDF/JS spec Quads

Parameters
- obj: any
Returns obj is Quad<any, any, any, any>

isRDFObject

isRDFObject(obj: any): obj is Quad_Object

- Defined in src/utils/terms.ts:125
TypeGuard for valid RDF/JS spec Object types

Parameters
- obj: any
Returns obj is Quad_Object

isRDFlibObject

isRDFlibObject(obj: any): obj is ObjectType

- Defined in src/utils/terms.ts:37
TypeGuard for valid RDFlib Object types, also allows Collections, Graphs

Parameters
- obj: any
Returns obj is ObjectType

isRDFlibPredicate

isRDFlibPredicate(obj: any): obj is Quad_Predicate

- Defined in src/utils/terms.ts:62
TypeGuard for valid RDF/JS spec Predicate types

Parameters
- obj: any
Returns obj is Quad_Predicate

isRDFlibSubject

isRDFlibSubject(obj: any): obj is ObjectType

- Defined in src/utils/terms.ts:50
TypeGuard for valid RDFlib Subject types, same as Object as RDFLib symmetrical.

Parameters
- obj: any
Returns obj is ObjectType

isStatement

isStatement(obj: any): obj is Statement<SubjectType, PredicateType, ObjectType, GraphType>

- Defined in src/utils/terms.ts:21
TypeGuard for RDFLib Statements

Parameters
- obj: any
Returns obj is Statement<SubjectType, PredicateType, ObjectType, GraphType>

isStore

isStore(obj: any): obj is Store

- Defined in src/utils/terms.ts:26
TypeGuard for RDFlib Stores

Parameters
- obj: any
Returns obj is Store

isSubject

isSubject(obj: any): obj is Quad_Subject

- Defined in src/utils/terms.ts:108
TypeGuard for valid RDF/JS spec Subject types

Parameters
- obj: any
Returns obj is Quad_Subject

isTerm

isTerm(obj: any): obj is Term

- Defined in src/utils/terms.ts:77
TypeGuard for RDF/JS spec Terms

Parameters
- obj: any
Returns obj is Term

isVariable

isVariable(obj: any): obj is Variable

- Defined in src/utils/terms.ts:71
TypeGuard for RDFLib Variables

Parameters
- obj: any
Returns obj is Variable

lit

lit(val: string, lang?: string, dt?: NamedNode): Literal

- Defined in src/types.ts:96
Parameters
- val: string
- Optional lang: string
- Optional dt: NamedNode
Returns Literal

literal

literal(value: string, languageOrDatatype?: string | NamedNode): Literal

- Defined in src/factories/factory-types.ts:72
Parameters
- value: string
- Optional languageOrDatatype: string | NamedNode
Returns Literal

parse

parse(str: string, kb: Formula, base: string, contentType?: string, callback?: CallbackFunc): void

- Defined in src/parse.ts:27
Parse a string and put the result into the graph kb. Normal method is sync. Unfortunately jsdonld is currently written to need to be called async. Hence the mess below with executeCallback.

Parameters
- str: string
  
  The input string to parse
- kb: Formula
  
  The store to use
- base: string
  
  The base URI to use
- contentType: string = 'text/turtle'
  
  The MIME content type string for the input - defaults to text/turtle
- Optional callback: CallbackFunc
Returns void

quad

quad(subject: Term, predicate: Term, object: Term, graph?: Term): Statement<SubjectType, PredicateType, ObjectType, GraphType>

- Defined in src/factories/factory-types.ts:84
Parameters
- subject: Term
- predicate: Term
- object: Term
- Optional graph: Term
Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>

queryToSPARQL

queryToSPARQL(query: any): string

- Defined in src/query-to-sparql.js:3
Parameters
- query: any
Returns string

serialize

serialize(target: null | Formula | NamedNode | BlankNode, kb: Formula, base?: unknown, contentType?: string, callback?: (err: undefined | null | Error, result?: string) => any, options?: { flags?: string; namespaces?: Record<string, string> }): string | undefined

- Defined in src/serialize.ts:22
Serialize to the appropriate format

Parameters
- target: null | Formula | NamedNode | BlankNode
- kb: Formula
- Optional base: unknown
- Optional contentType: string
- Optional callback: (err: undefined | null | Error, result?: string) => any
  - - (err: undefined | null | Error, result?: string): any
    - Parameters
      - err: undefined | null | Error
      - Optional result: string
      Returns any
- Optional options: { flags?: string; namespaces?: Record<string, string> }
  - Optional flags?: string
    
    A string of letters, each of which set an options e.g. deinprstux
  - Optional namespaces?: Record<string, string>
    
    A set of [prefix, uri] pairs that define namespace prefixes
Returns string | undefined

sparqlUpdateParser

sparqlUpdateParser(str: any, kb: any, base: any): { query: any }

- Defined in src/patch-parser.js:11
Parameters
- str: any
- kb: any
- base: any
Returns { query: any }
- query: any

st

st(subject: Quad_Subject, predicate: Quad_Predicate, object: Quad_Object, graph?: Quad_Graph): Statement<SubjectType, PredicateType, ObjectType, GraphType>

- Defined in src/types.ts:98
Parameters
- subject: Quad_Subject
- predicate: Quad_Predicate
- object: Quad_Object
- Optional graph: Quad_Graph
Returns Statement<SubjectType, PredicateType, ObjectType, GraphType>

sym

sym(value: string): NamedNode

- Defined in src/factories/factory-types.ts:68
Parameters
- value: string
Returns NamedNode

term

term<T>(value: ValueType): T

- Defined in src/index.ts:58
Type parameters
- T: FromValueReturns<any>
Parameters
- value: ValueType
Returns T

termValue

termValue(node: string | Term): string

- Defined in src/utils/termValue.ts:4
Retrieve the value of a term, or self if already a string.

Parameters
- node: string | Term
Returns string

triple

triple(subject: Term, predicate: Term, object: Term, graph?: Term): Quad<any, any, any, any>

- Defined in src/tf-types.ts:170
Returns a new instance of Quad. If graph is undefined or null it MUST set graph to a DefaultGraph.

Parameters
- subject: Term
- predicate: Term
- object: Term
- Optional graph: Term
Returns Quad<any, any, any, any>

variable

variable(value: string): Variable

- Defined in src/factories/factory-types.ts:74
Parameters
- value: string
Returns Variable

Generated using TypeDoc