Class EventBusClient

Hierarchy

  • NetworkClient
    • EventBusClient

Constructors

constructor

Methods

buildStackSpotError fetch isFreemium requestPermission resolveURL sendEvent stream setup

Constructors

constructor

Methods

ProtectedbuildStackSpotError

  • buildStackSpotError(error: HttpError): StackspotAPIError

  • Parameters

    • error: HttpError

    Returns StackspotAPIError

Protectedfetch

  • fetch(input: string | URL | Request, init?: RequestInit): Promise<Response>

  • Makes a request (same signature as globalThis.fetch). This request will prepend the base url to the url and, if there's an active session, include authentication headers.

    Parameters

    • input: string | URL | Request

      the url or request object.

    • Optionalinit: RequestInit

      the fetch options.

    Returns Promise<Response>

    a promise with the Response.

ProtectedisFreemium

  • isFreemium(): boolean

  • Checks whether or not the current account is freemium.

    Returns boolean

    true if it's a freemium account, false otherwise.

ProtectedrequestPermission

  • requestPermission(
        method: HTTPMethod,
        path: string,
        body?: string | object,
    ): Promise<boolean>

  • Verifies if the current user is allowed to send the given request.

    Parameters

    • method: HTTPMethod

      the request's method.

    • path: string

      the path to the resource.

    • Optionalbody: string | object

      the request's body.

    Returns Promise<boolean>

    a promise that resolves to true if it's allowed or false otherwise.

ProtectedresolveURL

  • resolveURL(path: string): URL

  • Builds a URL with the baseUrl of this network client and the path passed as parameter.

    Parameters

    • path: string

      the path to the resource.

    Returns URL

    a full URL.

sendEvent

Protectedstream

  • stream(
        input: string | URL | Request,
        init?: RequestInit,
    ): Promise<FetchEventStream>

  • Reads an EventSource from the endpoint. Differently than the original specification, this allows common HTTP requests with method and body to be made.

    Parameters

    • input: string | URL | Request

      the url or request object.

    • Optionalinit: RequestInit

      the fetch options.

    Returns Promise<FetchEventStream>

    a promise with a FetchEventStream, which is an AsyncGenerator.

    Example

    let events = this.stream('url', options)
    for await (let event of events) {
      console.log('<<', event.data)
    }

Staticsetup

  • setup(sessionManager: SessionManager, env: Env): void

  • Sets up all network clients. Must be called before attempting to make any request.

    Parameters

    • sessionManager: SessionManager

      An object with functions capable of checking, retrieving and ending the current session.

    • env: Env

      The environment to send the requests to.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods