AppleSauce
    Preparing search index...

    Interface IRelay

    interface IRelay {
        authenticated: boolean;
        authenticated$: Observable<boolean>;
        challenge: null | string;
        challenge$: Observable<null | string>;
        connected: boolean;
        connected$: Observable<boolean>;
        error$: Observable<null | Error>;
        message$: Observable<any>;
        notice$: Observable<string>;
        notices: string[];
        notices$: Observable<string[]>;
        url: string;
        auth(event: Event): Promise<PublishResponse>;
        authenticate(signer: AuthSigner): Promise<PublishResponse>;
        close(): void;
        event(event: Event): Observable<PublishResponse>;
        getInformation(): Promise<null | RelayInformation>;
        getLimitations(): Promise<undefined | null | Partial<Limitations>>;
        getSupported(): Promise<null | number[]>;
        multiplex(
            subMsg: () => any,
            unsubMsg: () => any,
            messageFilter: (value: any) => boolean,
        ): Observable<any>;
        negentropy(
            store: IEventStoreRead | IAsyncEventStoreRead | Event[],
            filter: Filter,
            reconcile: ReconcileFunction,
            opts?: NegentropySyncOptions,
        ): Promise<boolean>;
        publish(event: Event, opts?: PublishOptions): Promise<PublishResponse>;
        req(filters: FilterInput, id?: string): Observable<SubscriptionResponse>;
        request(
            filters: FilterInput,
            opts?: SubscriptionOptions,
        ): Observable<Event>;
        subscription(
            filters: FilterInput,
            opts?: SubscriptionOptions,
        ): Observable<SubscriptionResponse>;
        sync(
            store: IEventStoreRead | IAsyncEventStoreRead | Event[],
            filter: Filter,
            direction?: SyncDirection,
        ): Observable<Event>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    authenticated authenticated$ challenge challenge$ connected connected$ error$ message$ notice$ notices notices$ url

    Methods

    auth authenticate close event getInformation getLimitations getSupported multiplex negentropy publish req request subscription sync

    Properties

    authenticated: boolean
    authenticated$: Observable<boolean>
    challenge: null | string
    challenge$: Observable<null | string>
    connected: boolean
    connected$: Observable<boolean>
    error$: Observable<null | Error>
    message$: Observable<any>
    notice$: Observable<string>
    notices: string[]
    notices$: Observable<string[]>
    url: string

    Methods

    • Get the NIP-11 information document for the relay

      Returns Promise<null | RelayInformation>

    • Get the limitations for the relay

      Returns Promise<undefined | null | Partial<Limitations>>

    • Creates an Observable, that when subscribed to, sends a message, defined by the subMsg function, to the server over the socket to begin a subscription to data over that socket. Once data arrives, the messageFilter argument will be used to select the appropriate data for the resulting Observable. When finalization occurs, either due to unsubscription, completion, or error, a message defined by the unsubMsg argument will be sent to the server over the WebSocketSubject.

      Parameters

      • subMsg: () => any

        A function to generate the subscription message to be sent to the server. This will still be processed by the serializer in the WebSocketSubject's config. (Which defaults to JSON serialization)

      • unsubMsg: () => any

        A function to generate the unsubscription message to be sent to the server at finalization. This will still be processed by the serializer in the WebSocketSubject's config.

      • messageFilter: (value: any) => boolean

        A predicate for selecting the appropriate messages from the server for the output stream.

      Returns Observable<any>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods