Interface Echo

Public database API.

interface Echo {
    _value?: Space[];
    query: QueryFn;
    get default(): Space;
    get isReady(): MulticastObservable<boolean>;
    "[observable]"(): Observable<Space[]>;
    concat<R>(...observables: Observable<R>[]): MulticastObservable<R>;
    create(
        props?: Pick<
            SpaceProperties,
            "name"
            | "hue"
            | "icon"
            | "invocationTraceQueue",
        >,
    ): Promise<Space>;
    filter(callback: (value: Space[]) => boolean): MulticastObservable<Space[]>;
    flatMap<R>(
        callback: (value: Space[]) => MulticastObservable<R>,
    ): MulticastObservable<R>;
    forEach(callback: (value: Space[]) => void): Promise<void>;
    get(): Space[];
    get(id: SpaceId): undefined | Space;
    get(spaceKey: PublicKey): undefined | Space;
    import(archive: SpaceArchive): Promise<Space>;
    join(invitation: string | Invitation): AuthenticatingInvitationObservable;
    joinBySpaceKey(spaceKey: PublicKey): Promise<Space>;
    losslessConcat<R>(
        reducer: (currentValue: R, newValues: R[]) => R,
        ...observables: Observable<R>[],
    ): MulticastObservable<R>;
    map<R>(callback: (value: Space[]) => R): MulticastObservable<R>;
    reduce<R = Space[]>(
        callback: (previousValue: R, currentValue: Space[]) => R,
        initialValue?: R,
    ): MulticastObservable<R>;
    subscribe(observer: Observer<Space[]>): Subscription;
    subscribe(
        onNext: (value: Space[]) => void,
        onError?: (error: any) => void,
        onComplete?: () => void,
    ): Subscription;
    wait(__namedParameters?: { timeout?: number }): Promise<Space[]>;
    waitUntilReady(): Promise<void>;
}

Hierarchy (View Summary)

MulticastObservable<Space[]>
Queryable
- Echo

Index

Properties

`Protected` `Optional`_value

_value?: Space[]

query

query: QueryFn

Accessors

default

get default(): Space
Returns the default space.

Returns Space
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:32

isReady

get isReady(): MulticastObservable<boolean>
Observable which indicates when the default space is available.

Returns MulticastObservable<boolean>
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:15

Methods

[observable]

"[observable]"(): Observable<Space[]>
Returns Observable<Space[]>
Inherited from MulticastObservable.[observable]
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@types/zen-observable/index.d.ts:53

concat

concat<R>(...observables: Observable<R>[]): MulticastObservable<R>
Type Parameters
- R
Parameters
- ...observables: Observable<R>[]
Returns MulticastObservable<R>
Inherited from MulticastObservable.concat
- Defined in packages/common/async/dist/types/src/observable.d.ts:40

create

create(
    props?: Pick<
        SpaceProperties,
        "name"
        | "hue"
        | "icon"
        | "invocationTraceQueue",
    >,
): Promise<Space>
Creates a new space.
Parameters
- Optionalprops: Pick<SpaceProperties, "name" | "hue" | "icon" | "invocationTraceQueue">
Returns Promise<Space>
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:40

filter

filter(callback: (value: Space[]) => boolean): MulticastObservable<Space[]>
Parameters
- callback: (value: Space[]) => boolean
Returns MulticastObservable<Space[]>
Inherited from MulticastObservable.filter
- Defined in packages/common/async/dist/types/src/observable.d.ts:37

flatMap

flatMap<R>(
callback: (value: Space[]) => MulticastObservable<R>,
): MulticastObservable<R>
Type Parameters
- R
Parameters
- callback: (value: Space[]) => MulticastObservable<R>
Returns MulticastObservable<R>
Inherited from MulticastObservable.flatMap
- Defined in packages/common/async/dist/types/src/observable.d.ts:39

forEach

forEach(callback: (value: Space[]) => void): Promise<void>
Parameters
- callback: (value: Space[]) => void
Returns Promise<void>
Inherited from MulticastObservable.forEach
- Defined in packages/common/async/dist/types/src/observable.d.ts:35

get

get(): Space[]
Returns the list of spaces.

Returns Space[]
Overrides MulticastObservable.get
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:19
get(id: SpaceId): undefined | Space
Returns the space with the given id.
Parameters
- id: SpaceId
Returns undefined | Space
Overrides MulticastObservable.get
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:23
get(spaceKey: PublicKey): undefined | Space
Returns the space with the given key.
Parameters
- spaceKey: PublicKey
Returns undefined | Space
Deprecated
Use get(id: SpaceId).
Overrides MulticastObservable.get
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:28

import

import(archive: SpaceArchive): Promise<Space>
Creates a space from the given archive.
Parameters
- archive: SpaceArchive
Returns Promise<Space>
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:44

join

join(invitation: string | Invitation): AuthenticatingInvitationObservable
Joins an existing space using the given invitation.
Parameters
- invitation: string | Invitation
Returns AuthenticatingInvitationObservable
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:48

joinBySpaceKey

joinBySpaceKey(spaceKey: PublicKey): Promise<Space>
Parameters
- spaceKey: PublicKey
Returns Promise<Space>
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:49

losslessConcat

losslessConcat<R>(
reducer: (currentValue: R, newValues: R[]) => R,
...observables: Observable<R>[],
): MulticastObservable<R>
Concatenates multicast observables without losing the current value.
Type Parameters
- R
Parameters
- reducer: (currentValue: R, newValues: R[]) => R
  reduces the values of any multicast observables being concatenated into a single value
- ...observables: Observable<R>[]
  observables to concatenate
Returns MulticastObservable<R>
concatenated observable
Inherited from MulticastObservable.losslessConcat
- Defined in packages/common/async/dist/types/src/observable.d.ts:47

map

map<R>(callback: (value: Space[]) => R): MulticastObservable<R>
Type Parameters
- R
Parameters
- callback: (value: Space[]) => R
Returns MulticastObservable<R>
Inherited from MulticastObservable.map
- Defined in packages/common/async/dist/types/src/observable.d.ts:36

reduce

reduce<R = Space[]>(
callback: (previousValue: R, currentValue: Space[]) => R,
initialValue?: R,
): MulticastObservable<R>
Type Parameters
- R = Space[]
Parameters
- callback: (previousValue: R, currentValue: Space[]) => R
- OptionalinitialValue: R
Returns MulticastObservable<R>
Inherited from MulticastObservable.reduce
- Defined in packages/common/async/dist/types/src/observable.d.ts:38

subscribe(observer: Observer<Space[]>): Subscription
Parameters
- observer: Observer<Space[]>
Returns Subscription
Inherited from MulticastObservable.subscribe
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@types/zen-observable/index.d.ts:46
subscribe(
    onNext: (value: Space[]) => void,
    onError?: (error: any) => void,
    onComplete?: () => void,
): Subscription
Parameters
- onNext: (value: Space[]) => void
- OptionalonError: (error: any) => void
- OptionalonComplete: () => void
Returns Subscription
Inherited from MulticastObservable.subscribe
- Defined in node_modules/.pnpm/@[email protected]/node_modules/@types/zen-observable/index.d.ts:47

wait

wait(__namedParameters?: { timeout?: number }): Promise<Space[]>
Wait for the observable to complete.
Parameters
- Optional__namedParameters: { timeout?: number }
Returns Promise<Space[]>
Promise that resolves to the value of the observable at the time of completion.
Inherited from MulticastObservable.wait
- Defined in packages/common/async/dist/types/src/observable.d.ts:32

waitUntilReady

waitUntilReady(): Promise<void>
Resolves when the default space is available.

Returns Promise<void>
- Defined in packages/sdk/client-protocol/dist/types/src/echo.d.ts:36

Interface Echo

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

Protected Optional_value

query

Accessors

default

Returns Space

isReady

Returns MulticastObservable<boolean>

Methods

[observable]

Returns Observable<Space[]>

concat

Type Parameters

Parameters

Returns MulticastObservable<R>

create

Parameters

Returns Promise<Space>

filter

Parameters

Returns MulticastObservable<Space[]>

flatMap

Type Parameters

Parameters

Returns MulticastObservable<R>

forEach

Parameters

Returns Promise<void>

get

Returns Space[]

Parameters

Returns undefined | Space

Parameters

Returns undefined | Space

Deprecated

import

Parameters

Returns Promise<Space>

join

Parameters

Returns AuthenticatingInvitationObservable

joinBySpaceKey

Parameters

Returns Promise<Space>

losslessConcat

Type Parameters

Parameters

Returns MulticastObservable<R>

map

Type Parameters

Parameters

Returns MulticastObservable<R>

reduce

Type Parameters

Parameters

Returns MulticastObservable<R>

subscribe

Parameters

Returns Subscription

Parameters

Returns Subscription

wait

Parameters

Returns Promise<Space[]>

waitUntilReady

Returns Promise<void>

Settings

On This Page

`Protected` `Optional`_value