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` `Readonly` serializer

serializer: Serializer

Accessors

`Static` `Protected` options

get options(): DataSerializerConfig
Returns DataSerializerConfig
- Defined in src/rdf/RDFSerializer.ts:51

Methods

`Static` clone

clone<T, D>(object, dataType?): D
Clone a serializable object

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

`Static` deserialize

deserialize<T>(serializedData, dataType?): T
Deserialize data

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

Returns
Deserialized object
Type Parameters
- T
Parameters
- serializedData: any[]
  
  Data to deserialze
- Optional dataType: Constructor<T>
  
  Optional data type to specify deserialization type
Returns T | T[]
Overrides DataSerializer.deserialize
- Defined in src/rdf/RDFSerializer.ts:348

`Static` deserializeFromStore

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

`Static` deserializeFromString

deserializeFromString<T>(subject, input): T
Type Parameters
- T
Parameters
- subject: `http://${string}` | `https://${string}`
- input: string
Returns T
- Defined in src/rdf/RDFSerializer.ts:112

`Static` findRootMetaInfo

findRootMetaInfo(proto): ObjectMetadata
Find the root TypedJSON metadata

Deprecated
use DataSerializerUtils.getRootMetadata

Returns
Root object metadata
Parameters
- proto: any
  
  Prototype of target
Returns ObjectMetadata
Inherited from DataSerializer.findRootMetaInfo
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:57

`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:64

`Static` getMetadata

getMetadata(proto): ObjectMetadata
Get the TypedJSON metadata

Deprecated
use DataSerializerUtils.getMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d

Returns
Root object metadata
Parameters
- proto: any
  
  Prototype of target
Returns ObjectMetadata
Inherited from DataSerializer.getMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:40

`Static` getRootMetadata

getRootMetadata(proto): ObjectMetadata
Get the root TypedJSON metadata

Deprecated
use DataSerializerUtils.getRootMetadata

See
https://gist.github.com/krizka/c83fb1966dd57997a1fc02625719387d

Returns
Root object metadata
Parameters
- proto: any
  
  Prototype of target
Returns ObjectMetadata
Inherited from DataSerializer.getRootMetadata
- Defined in node_modules/@openhps/core/dist/types/data/DataSerializer.d.ts:49

`Static` getUriMetadata

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

`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:405

`Static` `Protected` registerRDFType

registerRDFType<T>(type): void
Type Parameters
- T
Parameters
- type: Serializable<T>
Returns void
- Defined in src/rdf/RDFSerializer.ts:58

`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:31

`Static` serialize

serialize<T>(data, config?): Thing
Serialize data

Returns
Serialized data
Type Parameters
- T
Parameters
- data: T
  
  Data to serialize
- Optional config: RDFSerializerConfig
  
  RDF serializer configuration
Returns Thing
Overrides DataSerializer.serialize
- Defined in src/rdf/RDFSerializer.ts:103

`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:206

`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:154

`Static` serializeToUri

serializeToUri<T>(data, baseUri?): `http://${string}` | `https://${string}`
Serialize an object to an URI

Returns
Resource 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}`
- Defined in src/rdf/RDFSerializer.ts:84

`Static` stringify

stringify(thing, options?): Promise<string>
Stringify a thing to RDF graph construct

Returns
Promise of a stringified graph
Parameters
- thing: any
  
  Thing to serialize
- Optional options: WriterOptions = {}
  
  Writer options
Returns Promise<string>
- Defined in src/rdf/RDFSerializer.ts:242

`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:63

Class RDFSerializer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns RDFSerializer

Properties

Static Protected Readonly deserializer

Static Protected eventEmitter

Static Protected Readonly knownRDFTypes

Static Protected Readonly knownTypes

Static Protected Readonly serializer

Accessors

Static Protected options

Returns DataSerializerConfig

Methods

Static clone

Returns

Type Parameters

T

D = T

Parameters

object: T

Optional dataType: Constructor<D>

Returns D

Static deserialize

Returns

Type Parameters

T

Parameters

serializedData: Thing

Optional dataType: Constructor<T>

Returns T

Returns

Type Parameters

T

Parameters

serializedData: any[]

Optional dataType: Constructor<T>

Returns T | T[]

Static deserializeFromStore

Type Parameters

T

Parameters

subject: BlankNode | NamedNode<string>

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

Returns T

Static deserializeFromString

Type Parameters

T

Parameters

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

input: string

Returns T

Static findRootMetaInfo

Deprecated

Returns

Parameters

proto: any

Returns ObjectMetadata

Static findTypeByName

Parameters

name: string

Returns Serializable<any>

Static getMetadata

Deprecated

See

Returns

Parameters

proto: any

Returns ObjectMetadata

Static getRootMetadata

Deprecated

See

Returns

Parameters

`Static` `Protected` `Readonly` deserializer

`Static` `Protected` eventEmitter

`Static` `Protected` `Readonly` knownRDFTypes

`Static` `Protected` `Readonly` knownTypes

`Static` `Protected` `Readonly` serializer

`Static` `Protected` options

`Static` clone

`Optional` dataType: Constructor<D>

`Static` deserialize

`Optional` dataType: Constructor<T>

`Optional` dataType: Constructor<T>

`Static` deserializeFromStore

`Static` deserializeFromString

`Static` findRootMetaInfo

`Static` findTypeByName

`Static` getMetadata

`Static` getRootMetadata

`Static` getUriMetadata

`Static` normalizeUri

`Static` `Protected` registerRDFType

`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

`Optional` options: WriterOptions = {}

`Static` unregisterType