Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JsonIdentityInfoOptions

Decorator options for JsonIdentityInfo.

Hierarchy

Index

Properties

Optional contextGroups

contextGroups: string[]

Property that defines whether this decorator is part of a context group or multiple groups.

Optional enabled

enabled: boolean

Property that defines whether this decorator is active or not.

default

true

generator

generator: ObjectIdGenerator | ((obj: any) => any)

Generator to use for producing Object Identifier for objects: either one of pre-defined generators from ObjectIdGenerator, or a custom generator.

Optional property

property: string

Name of JSON property in which Object Id will reside.

default

'@id'

Optional scope

scope: string

Scope is used to define applicability of an Object Id: all ids must be unique within their scope; where scope is defined as combination of this value and generator type.

Optional uuidLibrary

uuidLibrary: any

To be able to use JsonIdentityInfo with any UUID ObjectIdGenerator, an UUID library needs to be set. UUID libraries supported: https://github.com/uuidjs/uuid.

Optional uuidv1

Options for version 1 UUID Generator (see https://github.com/uuidjs/uuid#version-1-timestamp)

Optional uuidv3

Options for version 3 UUID Generator (see https://github.com/uuidjs/uuid#version-3-namespace)

Optional uuidv4

Options for version 4 UUID Generator (see https://github.com/uuidjs/uuid#version-4-random)

Optional uuidv5

Options for version 5 UUID Generator (see https://github.com/uuidjs/uuid#version-5-namespace)

Generated using TypeDoc