Askr
Generated API snapshot

@askrjs/fetch

Exports from the declarations published in @askrjs/fetch 0.0.1. Signatures are generated from the installed artifact.

  • @askrjs/fetch0.0.1

Exports

This entrypoint publishes 47 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

blobtype

blob: () => Codec<Blob>

contenttype

content: <T extends Record<string, Codec>>(variants: T) => Codec<{ [K in keyof T]: T[K] extends Codec<infer V> ? V : never; }[keyof T]>

createClienttype

createClient: <A extends ApiDefinition>(api: A, options?: ClientOptions) => ApiClient<A>

createFetchtype

createFetch: (options?: ClientOptions) => (call: AdHocCall) => Promise<FetchResult>

defineApitype

defineApi: <E extends Record<string, AnyEndpointDescriptor | EndpointBuilder>>(endpoints: E, metadata?: ApiMetadata) => ApiDefinition<Defined<E>>

deltype

del: (path: string) => EndpointBuilder<undefined, undefined, undefined, undefined, {}, {}>

emptytype

empty: () => Codec<undefined>

gettype

get: (path: string) => EndpointBuilder<undefined, undefined, undefined, undefined, {}, {}>

jsontype

json: { <T = unknown>(): Codec<T>; <V extends Validator>(schema: V): Codec<V extends Validator<infer T> ? T : never>; }

multiparttype

multipart: () => Codec<FormData>

optionstype

options: (path: string) => EndpointBuilder<undefined, undefined, undefined, undefined, {}, {}>

patchtype

patch: (path: string) => EndpointBuilder<undefined, undefined, undefined, undefined, {}, {}>

pathNamestype

pathNames: (path: string) => string[]

posttype

post: (path: string) => EndpointBuilder<undefined, undefined, undefined, undefined, {}, {}>

puttype

put: (path: string) => EndpointBuilder<undefined, undefined, undefined, undefined, {}, {}>

streamtype

stream: () => Codec<ReadableStream<Uint8Array>>

texttype

text: () => Codec<string>

unwraptype

unwrap: <T>(result: FetchResult<T>) => T

urlEncodedtype

urlEncoded: () => Codec<URLSearchParams>