light-process
API referenceClasses

Link

Defined in: src/models/Link.ts:25

Implements

Constructors

Constructor

new Link(config): Link;

Defined in: src/models/Link.ts:34

Parameters

config

LinkConfig

Returns

Link

Properties

data

data: Record<string, unknown>;

Defined in: src/models/Link.ts:30

Implementation of

LinkJSON.data


from

from: string;

Defined in: src/models/Link.ts:28

Implementation of

LinkJSON.from


id

readonly id: string;

Defined in: src/models/Link.ts:26

Implementation of

LinkJSON.id


maxIterations

maxIterations: number | null;

Defined in: src/models/Link.ts:32

Max iterations for back-links to prevent infinite loops (null = unlimited)

Implementation of

LinkJSON.maxIterations


name

name: string;

Defined in: src/models/Link.ts:27

Implementation of

LinkJSON.name


to

to: string;

Defined in: src/models/Link.ts:29

Implementation of

LinkJSON.to


when

when: Record<string, unknown> | null;

Defined in: src/models/Link.ts:31

MongoDB-style condition - link is only followed when this evaluates to true

Implementation of

LinkJSON.when

Methods

toJSON()

toJSON(): LinkJSON;

Defined in: src/models/Link.ts:53

Returns

LinkJSON


fromJSON()

static fromJSON(json): Link;

Defined in: src/models/Link.ts:65

Parameters

json

LinkJSON

Returns

Link

On this page