Class RDFSerializer

Hierarchy

DataSerializer
- RDFSerializer

Constructors

constructor

new RDFSerializer(): RDFSerializer
Returns RDFSerializer
Inherited from DataSerializer.constructor

Properties

`Static` `Protected` `Readonly` deserializer

deserializer: Deserializer

`Static` `Protected` eventEmitter

eventEmitter: EventEmitter

`Static` `Protected` `Readonly` knownRDFTypes

knownRDFTypes: Map<`http://${string}` | `https://${string}`, string[]> = ...

`Static` `Protected` `Readonly` knownTypes

knownTypes: Map<string, Serializable<any>>

`Static` `Protected` options

options: DataSerializerConfig = ...

`Static` `Protected` `Readonly` serializer

serializer: Serializer

Methods

`Static` clone

clone<T, D>(object, dataType?): D
Clone a serializable object
Type Parameters
- T
- D = T
Parameters
- object: T
  Serializable object
- Optional dataType: Constructor<D>
  Data type to clone to
Returns D
Cloned object
Inherited from DataSerializer.clone
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:66

`Static` deserialize

deserialize<T>(serializedData, dataType?): T
Deserialize data
Type Parameters
- T
Parameters
- serializedData: Thing
  Data to deserialze
- Optional dataType: Serializable<T>
  Optional data type to specify deserialization type
Returns T
Deserialized object
Overrides DataSerializer.deserialize
- Defined in src/rdf/RDFSerializer.ts:484
deserialize<T>(serializedData, dataType?): T | T[]
Deserialize data
Type Parameters
- T
Parameters
- serializedData: any[]
  Data to deserialze
- Optional dataType: Serializable<T>
  Optional data type to specify deserialization type
Returns T | T[]
Deserialized object
Overrides DataSerializer.deserialize
- Defined in src/rdf/RDFSerializer.ts:485

`Static` deserializeFromStore

deserializeFromStore<T>(subject, store): T
Type Parameters
- T
Parameters
- subject: NamedNode<string> | BlankNode
- store: Store<Quad, Quad, Quad, Quad>
Returns T
- Defined in src/rdf/RDFSerializer.ts:184

`Static` deserializeFromString

deserializeFromString<T>(subject, input, contentType?): T
Type Parameters
- T
Parameters
- subject: `http://${string}` | `https://${string}`
- input: string
- contentType: string = 'text/turtle'
Returns T
- Defined in src/rdf/RDFSerializer.ts:130

`Static` deserializeFromSubject

deserializeFromSubject<T>(subject): T
Type Parameters
- T
Parameters
- subject: Subject & {
  url: `http://${string}` | `https://${string}`;
  }
Returns T
- Defined in src/rdf/RDFSerializer.ts:424

`Static` deserializeFromSubjects

deserializeFromSubjects<T>(subject, subjects): T
Type Parameters
- T
Parameters
- subject: `http://${string}` | `https://${string}`
- subjects: Subject[]
Returns T
- Defined in src/rdf/RDFSerializer.ts:428

`Static` findRootMetaInfo

findRootMetaInfo(proto): ObjectMetadata
Find the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata
Inherited from DataSerializer.findRootMetaInfo
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:53

`Static` findTypeByName

findTypeByName(name): Serializable<any>
Parameters
- name: string
Returns Serializable<any>
Inherited from DataSerializer.findTypeByName
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:59

`Static` getMetadata

getMetadata(proto): ObjectMetadata
Get the TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
Inherited from DataSerializer.getMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:38

`Static` getRootMetadata

getRootMetadata(proto): ObjectMetadata
Get the root TypedJSON metadata
Parameters
- proto: any
  Prototype of target
Returns ObjectMetadata
Root object metadata

Deprecated
use DataSerializerUtils.getRootMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d
Inherited from DataSerializer.getRootMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:46

`Static` getUriMetadata

getUriMetadata<T>(dataType): ObjectMemberMetadata
Type Parameters
- T
Parameters
- dataType: Serializable<T>
Returns ObjectMemberMetadata
- Defined in src/rdf/RDFSerializer.ts:517

`Static` initialize

initialize(module): void
Parameters
- module: string
Returns void
- Defined in src/rdf/RDFSerializer.ts:81

`Static` normalizeUri

normalizeUri<T>(dataType, identifier, baseUri): `http://${string}` | `https://${string}`
Type Parameters
- T
Parameters
- dataType: Serializable<T>
- identifier: any
- baseUri: `http://${string}` | `https://${string}`
Returns `http://${string}` | `https://${string}`
- Defined in src/rdf/RDFSerializer.ts:544

`Static` registerRDFType

registerRDFType<T>(type, options?): void
Type Parameters
- T
Parameters
- type: Serializable<T>
- Optional options: MappedRDFTypeConverters<T>
Returns void
- Defined in src/rdf/RDFSerializer.ts:57

`Static` registerType

registerType<T>(type, converters?): void
Manually register a new type
Type Parameters
- T
Parameters
- type: Serializable<T>
  Type to register
- Optional converters: MappedTypeConverters<T>
  Optional converters
Returns void
Inherited from DataSerializer.registerType
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:30

`Static` serialize

serialize<T>(data, config?): Thing
Serialize data
Type Parameters
- T
Parameters
- data: T
  Data to serialize
- Optional config: RDFSerializerConfig
  RDF serializer configuration
Returns Thing
Serialized data
Overrides DataSerializer.serialize
- Defined in src/rdf/RDFSerializer.ts:121

`Static` serializeToQuads

serializeToQuads<T>(data, baseUri?): Quad[]
Type Parameters
- T
Parameters
- data: T
- Optional baseUri: `http://${string}` | `https://${string}`
Returns Quad[]
- Defined in src/rdf/RDFSerializer.ts:280

`Static` serializeToSubjects

serializeToSubjects<T>(data, baseUri?): Subject[]
Type Parameters
- T
Parameters
- data: T
- Optional baseUri: `http://${string}` | `https://${string}`
Returns Subject[]
- Defined in src/rdf/RDFSerializer.ts:228

`Static` serializeToUri

serializeToUri<T>(data, baseUri?): `http://${string}` | `https://${string}`
Serialize an object to an URI
Type Parameters
- T
Parameters
- data: T
  Data to serialize to an URI
- Optional baseUri: `http://${string}` | `https://${string}`
  Base URI
Returns `http://${string}` | `https://${string}`
Resource URI
- Defined in src/rdf/RDFSerializer.ts:102

`Static` stringify

stringify(thing, options?): Promise<string>
Stringify a thing to RDF graph construct
Parameters
- thing: any
  Thing to serialize
- Optional options: WriterOptions = {}
  Writer options
Returns Promise<string>
Promise of a stringified graph
- Defined in src/rdf/RDFSerializer.ts:319

`Static` unregisterType

unregisterType(type): void
Unregister a type
Parameters
- type: Serializable<any>
  Type to unregister
Returns void
Inherited from DataSerializer.unregisterType
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:58

Class RDFSerializer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RDFSerializer

Properties

Static Protected Readonly deserializer

Static Protected eventEmitter

Static Protected Readonly knownRDFTypes

Static Protected Readonly knownTypes

Static Protected options

Static Protected Readonly serializer

Methods

Static clone

Type Parameters

T

D = T

Parameters

object: T

Optional dataType: Constructor<D>

Returns D

Static deserialize

Type Parameters

T

Parameters

serializedData: Thing

Optional dataType: Serializable<T>

Returns T

Type Parameters

T

Parameters

serializedData: any[]

Optional dataType: Serializable<T>

Returns T | T[]

Static deserializeFromStore

Type Parameters

T

Parameters

subject: NamedNode<string> | BlankNode

store: Store<Quad, Quad, Quad, Quad>

Returns T

Static deserializeFromString

Type Parameters

T

Parameters

subject: `http://${string}` | `https://${string}`

input: string

contentType: string = 'text/turtle'

Returns T

Static deserializeFromSubject

Type Parameters

T

Parameters

subject: Subject & { url: `http://${string}` | `https://${string}`; }

Returns T

Static deserializeFromSubjects

Type Parameters

T

Parameters

subject: `http://${string}` | `https://${string}`

subjects: Subject[]

Returns T

Static findRootMetaInfo

Parameters

proto: any

Returns ObjectMetadata

Deprecated

Static findTypeByName

Parameters

name: string

Returns Serializable<any>

Static getMetadata

Parameters

proto: any

Returns ObjectMetadata

Deprecated

`Static` `Protected` `Readonly` deserializer

`Static` `Protected` eventEmitter

`Static` `Protected` `Readonly` knownRDFTypes

`Static` `Protected` `Readonly` knownTypes

`Static` `Protected` options

`Static` `Protected` `Readonly` serializer

`Static` clone

`Optional` dataType: Constructor<D>

`Static` deserialize

`Optional` dataType: Serializable<T>

`Optional` dataType: Serializable<T>

`Static` deserializeFromStore

`Static` deserializeFromString

`Static` deserializeFromSubject

subject: Subject & {
url: `http://${string}` | `https://${string}`;
}

`Static` deserializeFromSubjects

`Static` findRootMetaInfo

`Static` findTypeByName

`Static` getMetadata

`Static` getRootMetadata

`Static` getUriMetadata

`Static` initialize

`Static` normalizeUri

`Static` registerRDFType

`Optional` options: MappedRDFTypeConverters<T>

`Static` registerType

`Optional` converters: MappedTypeConverters<T>

`Static` serialize

`Optional` config: RDFSerializerConfig

`Static` serializeToQuads

`Optional` baseUri: `http://${string}` | `https://${string}`

`Static` serializeToSubjects

`Optional` baseUri: `http://${string}` | `https://${string}`

`Static` serializeToUri

`Optional` baseUri: `http://${string}` | `https://${string}`

`Static` stringify