@dxos/client
    Preparing search index...

    Interface Echo

    TODO(burdon): Public API (move comments here).

    interface Echo {
        _value?: Space[];
        query: QueryFn;
        get default(): Space;
        get isReady(): MulticastObservable<boolean>;
        "[observable]"(): Observable<Space[]>;
        concat<R>(...observables: Observable<R>[]): MulticastObservable<R>;
        create(meta?: PropertiesTypeProps): 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

    • MulticastObservable<Space[]>
      • Echo
    Index

    Properties

    _value? query

    Accessors

    default isReady

    Methods

    [observable] concat create filter flatMap forEach get import join joinBySpaceKey losslessConcat map reduce subscribe wait waitUntilReady

    Properties

    Protected Optional_value

    _value?: Space[]
    query: QueryFn

    Query all spaces.

    Accessors

    • get default(): Space

      Returns the default space.

      Returns Space

    • get isReady(): MulticastObservable<boolean>

      Observable which indicates when the default space is available.

      Returns MulticastObservable<boolean>

    Methods

    • Returns Observable<Space[]>

    • Type Parameters

      • R

      Parameters

      • ...observables: Observable<R>[]

      Returns MulticastObservable<R>

    • Parameters

      • callback: (value: Space[]) => boolean

      Returns MulticastObservable<Space[]>

    • Type Parameters

      • R

      Parameters

      • callback: (value: Space[]) => MulticastObservable<R>

      Returns MulticastObservable<R>

    • Parameters

      • callback: (value: Space[]) => void

      Returns Promise<void>

    • Returns the list of spaces.

      Returns Space[]

    • Returns the space with the given id.

      Parameters

      Returns undefined | Space

    • Returns the space with the given key.

      Parameters

      Returns undefined | Space

      Use get(id: SpaceId).

    • Creates a space from the given archive.

      Parameters

      • archive: SpaceArchive

      Returns Promise<Space>

    • Parameters

      Returns Promise<Space>

    • 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

    • Type Parameters

      • R

      Parameters

      • callback: (value: Space[]) => R

      Returns MulticastObservable<R>

    • Type Parameters

      Parameters

      • callback: (previousValue: R, currentValue: Space[]) => R
      • OptionalinitialValue: R

      Returns MulticastObservable<R>

    • Parameters

      • observer: Observer<Space[]>

      Returns Subscription

    • Parameters

      • onNext: (value: Space[]) => void
      • OptionalonError: (error: any) => void
      • OptionalonComplete: () => void

      Returns Subscription

    • 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.

    • Resolves when the default space is available.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods