@dxos/halo
    Preparing search index...

    Interface Flow

    An in-flight invitation, host or guest side. Produced by Identity.share/join and Space.share/join; its lifecycle is then driven through this handle and the Service.

    interface Flow {
        code: Effect<string, InvitationError>;
        events: Stream<Event>;
        id: string;
        kind: Kind;
        authenticate(code: string): Effect<void, InvitationError>;
        cancel(): Effect<void>;
    }
    Index

    Properties

    code events id kind

    Methods

    authenticate cancel

    Properties

    code: Effect<string, InvitationError>

    Encoded, shareable invitation code (host side). Fails when the flow errors before it is complete.

    events: Stream<Event>

    Hot stream of lifecycle events; completes after a terminal event.

    id: string
    kind: Kind

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods