Class MinilinkCollection<MGO, L>

Type Parameters

MGO extends MinilinksGeneratorOptions = typeof MinilinksGeneratorOptionsDefault
L extends Link<Id> = Link<Id>

Constructors

constructor

new MinilinkCollection<MGO, L>(options?, memory?): MinilinkCollection<MGO, L>
Type Parameters
- MGO extends MinilinksGeneratorOptions = MinilinksGeneratorOptions
- L extends Link<Id> = Link<Id>
Parameters
- Optionaloptions: MGO
- Optionalmemory: any
Returns MinilinkCollection<MGO, L>
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:907

Properties

_updating

_updating: boolean = false

byFrom

byFrom: {
[id: Id]: Links<Id, L>;
} = {}

byId

byId: {
[id: Id]: L;
} = {}

byTo

byTo: {
[id: Id]: Links<Id, L>;
} = {}

byType

byType: {
[id: Id]: Links<Id, L>;
} = {}

`Optional`deep

deep?: DeepClient<Link<Id>>

emitter

emitter: EventEmitter<DefaultEventMap>

links

links: Links<Id, L> = ...

options

options: MGO

toPlain

toPlain: (<Ref>(link: any) => LinkPlain<Ref>) = toPlain

types

types: {
[id: Id]: Links<Id, L>;
} = {}

useMinilinksApply

useMinilinksApply: (<L>(ml: any, name: string, data?: MinilinksApplyInput | Links<Id, L>) => {
    anomalies?: MinilinkError[];
    data: L[];
    errors?: MinilinkError[];
    plainLinks: L[];
}) = useMinilinksApply

useMinilinksFilter

useMinilinksFilter: (<L, R>(ml: any, filter: ((currentLink: L, oldLink: L, newLink: L) => boolean), results: ((l?: L, ml?: any, oldLink?: L, newLink?: L) => R), interval?: number) => R) = useMinilinksFilter

useMinilinksHandle

useMinilinksHandle: (<L>(ml: any, handler: ((event: any, oldLink: any, newLink: any) => any)) => void) = useMinilinksHandle

useMinilinksId

useMinilinksId: ((ml: any, start: QueryLink | DeepClientStartItem, ...path: DeepClientPathItem[]) => Id | void) = useMinilinksId

useMinilinksQuery

useMinilinksQuery: (<L>(ml: any, query: Id | QueryLink, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => any) = useMinilinksQuery

Type declaration

- <L>(ml, query, options?): any
- React hook. Returns reactiviely links from minilinks, by query in deeplinks dialect. Recalculates when query changes. (Take query into useMemo!).
  Type Parameters
  - L extends Link<Id>
  Parameters
  - ml: any
  - query: Id | QueryLink
  - Optionaloptions: MinilinksQueryOptions<MinilinksQueryOptionAggregate>
  Returns any

useMinilinksSubscription

useMinilinksSubscription: (<L>(ml: any, query: Id | QueryLink, options?: MinilinksQueryOptions<MinilinksQueryOptionAggregate>) => any) = useMinilinksSubscription

Type declaration

- <L>(ml, query, options?): any
- React hook. Returns reactiviely links from minilinks, by query in deeplinks dialect. Recalculates when data in minilinks changes. (Take query into useMemo!).
  Type Parameters
  - L extends Link<Id>
  Parameters
  - ml: any
  - query: Id | QueryLink
  - Optionaloptions: MinilinksQueryOptions<MinilinksQueryOptionAggregate>
  Returns any

virtual

virtual: {
[id: Id]: Id;
} = {}

virtualCounter

virtualCounter: number = -1

virtualInverted

virtualInverted: {
[id: Id]: Id;
} = {}

Methods

_toPlainLinksArray

_toPlainLinksArray(linkOrLinks, applyOptions, plainLinksArray, returnLinksPathsById): void
Parameters
- linkOrLinks: any
- applyOptions: any
- plainLinksArray: any
- returnLinksPathsById: any
Returns void
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:683

_traveled

_traveled(array): Links<Id, L>
Parameters
- array: any[]
Returns Links<Id, L>
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:919

add

add(linksArray, applyName?): {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}
Parameters
- linksArray: any[]
- applyName: string = ''
Returns {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}
- Optionalanomalies?: MinilinkError[]
- Optionalerrors?: MinilinkError[]
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:482

apply

apply(_input, applyName?, applyOptions?): {
    anomalies?: MinilinkError[];
    data: L[];
    errors?: MinilinkError[];
    plainLinks: L[];
}
Parameters
- _input: any[] | MinilinksApplyInput
- applyName: string = ''
- OptionalapplyOptions: ApplyOptions
Returns {
    anomalies?: MinilinkError[];
    data: L[];
    errors?: MinilinkError[];
    plainLinks: L[];
}
- Optionalanomalies?: MinilinkError[]
- data: L[]
- Optionalerrors?: MinilinkError[]
- plainLinks: L[]
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:692

id

id(start, ...path): Id
Find id of a link from minilinks by link name or id and contain values (names) as path items
Parameters
- start: DeepClientStartItem
  A name or id of a link
- Rest...path: DeepClientPathItem[]
  Contain values (names) as path items
Returns Id
A promise that resolves to the id of the link
Example
Get Core Package Link Id
```
const corePackageLinkId = deep.minilinks.id("@deep-foundation/core")
```
Get User Type Link Id From Core Package
```
const userTypeLinkId = deep.minilinks.id("@deep-foundation/core", "User")
```
Get the link called "My Nested Link Name" contained in the link called "My Link Name" contained the current user
```
const myLinkId = deep.minilinks.id(deep.linkId, 'My Link Name', 'My Nested Link Name')
```
Get Admin Link Id
```
const adminLinkId = deep.minilinks.id("deep", "admin")
```
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:381

name

name(input): string
Returns a name of a link input that is located in a value of a contain link pointing to the link input according to links stored in minilinks
Parameters
- input: Id | Link<Id>
Returns string
Example
```
const userTypeLinkId = await deep.id("@deep-foundation/core", "User");
const userTypeLinkName = deep.minilinks.name(userTypeLinkId);
```
Note: "@deep-foundation/core" package, "User" link, Contain link pointing from "@deep-foundation/core" to "User" must be in minilinks
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:419

query

query<A>(query, options?): A extends string
? any
: Links<Id, L>
Type Parameters
- A
Parameters
- query: Id | QueryLink
- Optionaloptions: MinilinksQueryOptions<A>
Returns A extends string
? any
: Links<Id, L>
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:334

remove

remove(idsArray, applyName?): {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}
Parameters
- idsArray: any[]
- OptionalapplyName: string
Returns {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}
- Optionalanomalies?: MinilinkError[]
- Optionalerrors?: MinilinkError[]
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:604

select

select(query, options?): any
Parameters
- query: Id | QueryLink
- Optionaloptions: MinilinksQueryOptions<MinilinksQueryOptionAggregate>
Returns any
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:350

subscribe(query, options?): Observable<any>
minilinks.subscribe
Parameters
- query: Id | QueryLink
- Optionaloptions: MinilinksQueryOptions<MinilinksQueryOptionAggregate>
Returns Observable<any>
Example
```
minilinks.subscribe({ type_id: 2 }).subscribe({ next: (links) => {}, error: (err) => {} });
```
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:450

symbol

symbol(input): string
Returns a symbol of a link input that is located in a value of a contain link pointing to the link input according to links stored in minilinks
Parameters
- input: Id | Link<Id>
Returns string
Example
```
const userTypeLinkId = await deep.id("@deep-foundation/core", "User");
const userTypeLinkName = deep.minilinks.name(userTypeLinkId);
```
Note: "@deep-foundation/core" package, "User" link, Contain link pointing from "@deep-foundation/core" to "User" must be in minilinks
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:438

update

update(linksArray, applyName?): {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}
Parameters
- linksArray: any[]
- OptionalapplyName: string
Returns {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}
- Optionalanomalies?: MinilinkError[]
- Optionalerrors?: MinilinkError[]
- Defined in work/deeplinks/deeplinks/imports/minilinks.tsx:853

Class MinilinkCollection<MGO, L>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MinilinkCollection<MGO, L>

Properties

_updating

byFrom

byId

byTo

byType

Optionaldeep

emitter

links

options

toPlain

types

useMinilinksApply

useMinilinksFilter

useMinilinksHandle

useMinilinksId

useMinilinksQuery

Type declaration

Type Parameters

Parameters

Returns any

useMinilinksSubscription

Type declaration

Type Parameters

Parameters

Returns any

virtual

virtualCounter

virtualInverted

Methods

_toPlainLinksArray

Parameters

Returns void

_traveled

Parameters

Returns Links<Id, L>

add

Parameters

Returns { anomalies?: MinilinkError[]; errors?: MinilinkError[]; }

Optionalanomalies?: MinilinkError[]

Optionalerrors?: MinilinkError[]

apply

Parameters

Returns { anomalies?: MinilinkError[]; data: L[]; errors?: MinilinkError[]; plainLinks: L[]; }

Optionalanomalies?: MinilinkError[]

data: L[]

Optionalerrors?: MinilinkError[]

plainLinks: L[]

id

Parameters

Returns Id

Example

Get Core Package Link Id

Get User Type Link Id From Core Package

Get the link called "My Nested Link Name" contained in the link called "My Link Name" contained the current user

Get Admin Link Id

name

Parameters

Returns string

Example

query

Type Parameters

Parameters

Returns A extends string ? any : Links<Id, L>

remove

Parameters

Returns { anomalies?: MinilinkError[]; errors?: MinilinkError[]; }

Optionalanomalies?: MinilinkError[]

Optionalerrors?: MinilinkError[]

`Optional`deep

Returns {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}

`Optional`anomalies?: MinilinkError[]

`Optional`errors?: MinilinkError[]

Returns {
anomalies?: MinilinkError[];
data: L[];
errors?: MinilinkError[];
plainLinks: L[];
}

`Optional`anomalies?: MinilinkError[]

`Optional`errors?: MinilinkError[]

Returns A extends string
? any
: Links<Id, L>

Returns {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}

`Optional`anomalies?: MinilinkError[]

`Optional`errors?: MinilinkError[]

Returns {
anomalies?: MinilinkError[];
errors?: MinilinkError[];
}

`Optional`anomalies?: MinilinkError[]

`Optional`errors?: MinilinkError[]