IRdfProperty | ts-rdf-mapper

Index

clazz: any

Used to identify type of object at runtime.

MUST be used if the property extends Object i.e Person {}

class Person {
    @RdfProperty({predicate: 'schema:hasFriend', clazz: Person})
    friend: Person;
}

this property is required for instances to be created when deserializing turtle to objects

deserializer: any

inverseOfPredicate: string

isArray: boolean

Specify if this is an array

this property is required for deserializing from turtle

class Person {
    @RdfProperty({predicate: 'schema:hasFriend', clazz: Person, isArray: true})
    friend: Person[];
}

class Person {
    @RdfProperty({predicate: 'schema:name', isArray: true})
    name: string[];
}

isIRI: boolean

Treat a string as IRI Resource

lang: string

language tag, i.e. 'en' or 'de' or 'ru', etc

class Person {
    @RdfProperty({predicate: 'schema:name', lang: 'en'})
    name: string;
}

predicate: string

predicate

NOTE: @RdfPrefixes defining schema must be present for the following example

 class Person {
     @RdfProperty({predicate: 'schema:name', lang: 'en'})
     name: string;
 }

or if @RdfPrefixes were not defined

 class Person {
     @RdfProperty({predicate: 'http://schema.org/name', lang: 'en'})
     name: string;
 }

serializer: any

Serializer must either extend AbstractBNodeSerializer class or implement the IRDFSerializer interface

xsdType: string

XSDDataType can be used or a string

class Person {
    @RdfProperty({predicate: 'schema:name', xsdType: XSDDataType.XSD_STRING})
    name: string;
}