lunify.js
Version:
A basic api wrapper for the spotify api covering the oauth routes.
63 lines (62 loc) • 1.82 kB
TypeScript
/// <reference types="node" />
import { Readable } from 'node:stream';
import { RequestDomain } from '../lib';
export interface Options {
clientId: string;
clientSecret: string;
oauth?: {
redirectUri: string;
};
}
export interface RequestData {
/**
* The domain used for making requests
* @default https://api.spotify.com/v1
*/
domain?: RequestDomain;
/**
* If this requests requires basic client authentication (not oAuth)
* @default false
*/
authRequired?: boolean;
/**
* If this requests requires client authentication (not oAuth)
* @link https://developer.spotify.com/documentation/web-api/tutorials/getting-started#Request-an access-token
* @default false
*/
advancedAuthRequired?: boolean;
/**
* The body of the request.
* If providing as BodyInit, set `passThroughBody: true` in the request options.
*/
body?: BodyInit | Record<string, unknown>;
/**
* Additional headers to be sent with this request.
*/
headers?: Record<string, string>;
/**
* Query string parameters to be appended to the endpoint URL.
*/
query?: Record<string, string | number | boolean>;
}
export type RouteLike = string;
export declare enum RequestMethod {
Get = "GET",
Post = "POST",
Put = "PUT",
Patch = "PATCH",
Delete = "DELETE"
}
export interface InternalRequest extends RequestData {
route: RouteLike;
method: RequestMethod;
}
export interface ResponseLike extends Pick<Response, 'arrayBuffer' | 'bodyUsed' | 'headers' | 'json' | 'ok' | 'status' | 'text'> {
body: Readable | ReadableStream | null;
}
export interface StructureFetchOptions {
/**
* Fetch from the spotify api regardless if it's cached or not
*/
force?: boolean;
}