Class RawClient

Low-level HTTP client that returns raw responses without throwing on non-2xx status codes. Useful when you need access to status codes, headers, or want to handle errors manually.

Example

const raw = sc.raw;
const res = await raw.get('/tracks/123456');
console.log(res.status, res.headers, res.data);

Index

Constructors

constructor

Methods

delete get post put request

Constructors

constructor

new RawClient(
    baseUrl: string,
    getToken: () => string | undefined,
    fetchFn: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    },
): RawClient
Parameters
- baseUrl: string
- getToken: () => string | undefined
- fetchFn: {
  (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
  (input: string | URL | Request, init?: RequestInit): Promise<Response>;
  }
  - (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
    MDN Reference
    
    Parameters
    input: URL | RequestInfo
    Optionalinit: RequestInit
    Returns Promise<Response>
    (input: string | URL | Request, init?: RequestInit): Promise<Response>
    MDN Reference
    
    Parameters
    input: string | URL | Request
    Optionalinit: RequestInit
    Returns Promise<Response>
Returns RawClient
- Defined in src/client/raw.ts:25

Methods

delete

delete<T = unknown>(path: string): Promise<RawResponse<T>>
DELETE shorthand
Type Parameters
- T = unknown
Parameters
- path: string
Returns Promise<RawResponse<T>>
- Defined in src/client/raw.ts:137

get

get<T = unknown>(
path: string,
params?: Record<string, string | number | boolean | undefined>,
): Promise<RawResponse<T>>
GET shorthand
Type Parameters
- T = unknown
Parameters
- path: string
- Optionalparams: Record<string, string | number | boolean | undefined>
Returns Promise<RawResponse<T>>
- Defined in src/client/raw.ts:119

post

post<T = unknown>(path: string, body?: unknown): Promise<RawResponse<T>>
POST shorthand
Type Parameters
- T = unknown
Parameters
- path: string
- Optionalbody: unknown
Returns Promise<RawResponse<T>>
- Defined in src/client/raw.ts:127

put

put<T = unknown>(path: string, body?: unknown): Promise<RawResponse<T>>
PUT shorthand
Type Parameters
- T = unknown
Parameters
- path: string
- Optionalbody: unknown
Returns Promise<RawResponse<T>>
- Defined in src/client/raw.ts:132

request

request<T = unknown>(
    __namedParameters: {
        body?: unknown;
        method: string;
        path: string;
        query?: Record<string, string | number | boolean | undefined>;
        token?: string;
    },
): Promise<RawResponse<T>>
Make a raw HTTP request. Path template placeholders like {id} are substituted from matching keys in query before the remaining query params are appended to the URL as search parameters.
Type Parameters
- T = unknown
Parameters
- __namedParameters: {
      body?: unknown;
      method: string;
      path: string;
      query?: Record<string, string | number | boolean | undefined>;
      token?: string;
  }
Returns Promise<RawResponse<T>>
- Defined in src/client/raw.ts:36

Class RawClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Parameters

Returns Promise<Response>

Parameters

Returns Promise<Response>

Returns RawClient

Methods

delete

Type Parameters

Parameters

Returns Promise<RawResponse<T>>

get

Type Parameters

Parameters

Returns Promise<RawResponse<T>>

post

Type Parameters

Parameters

Returns Promise<RawResponse<T>>

put

Type Parameters

Parameters

Returns Promise<RawResponse<T>>

request

Type Parameters

Parameters

Returns Promise<RawResponse<T>>

Settings

On This Page