Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Response<TGraph, TQuery>

Base class representing any response returned by API. Extends the native Response object of Fetch API and has all the data of the original response in addition to a few custom methods. You shouldn't need to construct instances of this class directly unless you're building a custom API client with this SDK.

Type Parameters

  • TGraph extends Core.Graph

  • TQuery extends Query<TGraph> | undefined = undefined

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected Readonly _cache

_cache: Storage

Resolver cache implementing Web Storage API.

Protected Readonly _console

_console: Consola

Shared Consola instance.

Protected Readonly _fetch

_fetch: ((input: RequestInfo, init?: RequestInit) => Promise<Response>)

Type declaration

Readonly body

body: null | ReadableStream<Uint8Array>

Readonly bodyUsed

bodyUsed: boolean

Readonly headers

headers: Headers

Readonly ok

ok: boolean

Readonly redirected

redirected: boolean

Readonly status

status: number

Readonly statusText

statusText: string

Readonly trailer

trailer: Promise<Headers>

Readonly type

type: ResponseType

Readonly url

url: string

Static Readonly v8n

v8n: { constructor: any } = ...

Type declaration

  • constructor: any

Methods

arrayBuffer

  • arrayBuffer(): Promise<ArrayBuffer>

  • Returns Promise<ArrayBuffer>

blob

  • blob(): Promise<Blob>

  • Returns Promise<Blob>

clone

  • Returns Response

formData

  • formData(): Promise<FormData>

  • Returns Promise<FormData>

json

  • Gets JSON data from the response body and generates a followable response with a number of shortcuts for the most common actions.

    Returns Promise<FollowableResource<TGraph, TQuery>>

    Followable API response.

text

  • text(): Promise<string>

  • Returns Promise<string>

Static error

  • Returns Response

Static redirect

  • redirect(url: string, status?: number): Response

  • Parameters

    • url: string
    • Optional status: number

    Returns Response

Generated using TypeDoc