Interface Ref<T>

Represents materialized reference to a target. This is the data type for the fields marked as ref.

interface Ref<T> {
    "[RefTypeId]": { _T: T };
    get dxn(): DXN;
    get isAvailable(): boolean;
    get target(): undefined | T;
    encode(): EncodedReference;
    load(): Promise<T>;
    noInline(): Ref<T>;
    pipe<A>(this: A): A;
    pipe<A, B = never>(this: A, ab: (_: A) => B): B;
    pipe<A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C;
    pipe<A, B = never, C = never, D = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
    ): D;
    pipe<A, B = never, C = never, D = never, E = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
    ): E;
    pipe<A, B = never, C = never, D = never, E = never, F = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
    ): F;
    pipe<A, B = never, C = never, D = never, E = never, F = never, G = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
    ): G;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
    ): H;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
    ): I;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
    ): J;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
    ): K;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
    ): L;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
    ): M;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
    ): N;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
    ): O;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
    ): P;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
    ): Q;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
    ): R;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
    ): S;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
        T = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
        st: (_: S) => T,
    ): T;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
        T = never,
        U = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
        st: (_: S) => T,
        tu: (_: T) => U,
    ): U;
    pipe<
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
        T = never,
        U = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
        st: (_: S) => T,
        tu: (_: T) => U,
    ): U;
    tryLoad(): Promise<undefined | T>;
}

Type Parameters

Hierarchy

Pipeable
- Ref

Index

Properties

[RefTypeId]

"[RefTypeId]": { _T: T }

Accessors

dxn

get dxn(): DXN
Target object DXN.

Returns DXN
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:82

isAvailable

get isAvailable(): boolean
Returns true if the reference has a target available (inlined or resolver set).

Returns boolean
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:86

target

get target(): undefined | T
Returns undefined | T
The reference target. May return undefined if the object is not loaded in the working set. Accessing this property, even if it returns undefined will trigger the object to be loaded to the working set.
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:92

Methods

encode

encode(): EncodedReference
Serializes the reference to a JSON object. The serialization format is compatible with the IPLD-style encoded references. When a reference has a saved target (i.e. the target or object holding the reference is not in the database), the target is included in the serialized object.

Examples: { "/": "dxn:..." } { "/": "dxn:...", "target": { ... } }

Returns EncodedReference
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:125

load

load(): Promise<T>
Returns Promise<T>
Promise that will resolves with the target object. Will load the object from disk if it is not present in the working set.

Throws
If the object is not available locally.
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:98

noInline

noInline(): Ref<T>
Do not inline the target object in the reference. Makes .target unavailable unless the reference is connected to a database context.

When serialized with toJSON, the difference is between: { "/": "dxn:..." } and { "/": "dxn:...", "target": { ... } }

Clones the reference object.

Returns Ref<T>
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:114

pipe

pipe<A>(this: A): A
Type Parameters
- A
Parameters
- this: A
Returns A
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:10
pipe<A, B = never>(this: A, ab: (_: A) => B): B
Type Parameters
- A
- B = never
Parameters
- this: A
- ab: (_: A) => B
Returns B
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:11
pipe<A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C
Type Parameters
- A
- B = never
- C = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
Returns C
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:12
pipe<A, B = never, C = never, D = never>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
): D
Type Parameters
- A
- B = never
- C = never
- D = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
Returns D
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:13
pipe<A, B = never, C = never, D = never, E = never>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
): E
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
Returns E
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:14
pipe<A, B = never, C = never, D = never, E = never, F = never>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
): F
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
Returns F
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:15
pipe<A, B = never, C = never, D = never, E = never, F = never, G = never>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
): G
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
Returns G
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:16
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
): H
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
Returns H
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:17
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
): I
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
Returns I
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:18
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
): J
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
Returns J
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:19
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
): K
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
Returns K
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:20
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
): L
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
Returns L
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:21
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
): M
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
Returns M
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:22
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
): N
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
Returns N
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:23
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
): O
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
Returns O
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:24
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
): P
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
Returns P
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:25
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
    Q = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
    pq: (_: P) => Q,
): Q
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
- Q = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
- pq: (_: P) => Q
Returns Q
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:26
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
    Q = never,
    R = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
    pq: (_: P) => Q,
    qr: (_: Q) => R,
): R
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
- Q = never
- R = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
- pq: (_: P) => Q
- qr: (_: Q) => R
Returns R
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:27
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
    Q = never,
    R = never,
    S = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
    pq: (_: P) => Q,
    qr: (_: Q) => R,
    rs: (_: R) => S,
): S
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
- Q = never
- R = never
- S = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
- pq: (_: P) => Q
- qr: (_: Q) => R
- rs: (_: R) => S
Returns S
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:28
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
    Q = never,
    R = never,
    S = never,
    T = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
    pq: (_: P) => Q,
    qr: (_: Q) => R,
    rs: (_: R) => S,
    st: (_: S) => T,
): T
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
- Q = never
- R = never
- S = never
- T = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
- pq: (_: P) => Q
- qr: (_: Q) => R
- rs: (_: R) => S
- st: (_: S) => T
Returns T
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:29
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
    Q = never,
    R = never,
    S = never,
    T = never,
    U = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
    pq: (_: P) => Q,
    qr: (_: Q) => R,
    rs: (_: R) => S,
    st: (_: S) => T,
    tu: (_: T) => U,
): U
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
- Q = never
- R = never
- S = never
- T = never
- U = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
- pq: (_: P) => Q
- qr: (_: Q) => R
- rs: (_: R) => S
- st: (_: S) => T
- tu: (_: T) => U
Returns U
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:30
pipe<
    A,
    B = never,
    C = never,
    D = never,
    E = never,
    F = never,
    G = never,
    H = never,
    I = never,
    J = never,
    K = never,
    L = never,
    M = never,
    N = never,
    O = never,
    P = never,
    Q = never,
    R = never,
    S = never,
    T = never,
    U = never,
>(
    this: A,
    ab: (_: A) => B,
    bc: (_: B) => C,
    cd: (_: C) => D,
    de: (_: D) => E,
    ef: (_: E) => F,
    fg: (_: F) => G,
    gh: (_: G) => H,
    hi: (_: H) => I,
    ij: (_: I) => J,
    jk: (_: J) => K,
    kl: (_: K) => L,
    lm: (_: L) => M,
    mn: (_: M) => N,
    no: (_: N) => O,
    op: (_: O) => P,
    pq: (_: P) => Q,
    qr: (_: Q) => R,
    rs: (_: R) => S,
    st: (_: S) => T,
    tu: (_: T) => U,
): U
Type Parameters
- A
- B = never
- C = never
- D = never
- E = never
- F = never
- G = never
- H = never
- I = never
- J = never
- K = never
- L = never
- M = never
- N = never
- O = never
- P = never
- Q = never
- R = never
- S = never
- T = never
- U = never
Parameters
- this: A
- ab: (_: A) => B
- bc: (_: B) => C
- cd: (_: C) => D
- de: (_: D) => E
- ef: (_: E) => F
- fg: (_: F) => G
- gh: (_: G) => H
- hi: (_: H) => I
- ij: (_: I) => J
- jk: (_: J) => K
- kl: (_: K) => L
- lm: (_: L) => M
- mn: (_: M) => N
- no: (_: N) => O
- op: (_: O) => P
- pq: (_: P) => Q
- qr: (_: Q) => R
- rs: (_: R) => S
- st: (_: S) => T
- tu: (_: T) => U
Returns U
Inherited from Pipeable.Pipeable.pipe
- Defined in node_modules/.pnpm/[email protected]/node_modules/effect/dist/dts/Pipeable.d.ts:31

tryLoad

tryLoad(): Promise<undefined | T>
Returns Promise<undefined | T>
Promise that will resolves with the target object or undefined if the object is not loaded locally.
- Defined in packages/core/echo/echo/dist/types/src/internal/ref/ref.d.ts:102

Interface Ref<T>

Type Parameters

Hierarchy

Index

Properties

Accessors

Methods

Properties

[RefTypeId]

Accessors

dxn

Returns DXN

isAvailable

Returns boolean

target

Returns undefined | T

Methods

encode

Returns EncodedReference

load

Returns Promise<T>

Throws

noInline

Returns Ref<T>

pipe

Type Parameters

Parameters

Returns A

Type Parameters

Parameters

Returns B

Type Parameters

Parameters

Returns C

Type Parameters

Parameters

Returns D

Type Parameters

Parameters

Returns E

Type Parameters

Parameters

Returns F

Type Parameters

Parameters

Returns G

Type Parameters

Parameters

Returns H

Type Parameters

Parameters

Returns I

Type Parameters

Parameters

Returns J

Type Parameters

Parameters

Returns K

Type Parameters

Parameters

Returns L

Type Parameters

Parameters

Returns M

Type Parameters

Parameters

Returns N

Type Parameters

Parameters

Returns O

Type Parameters

Parameters

Returns P

Type Parameters

Parameters

Returns Q

Type Parameters

Parameters

Returns R

Type Parameters