global.HeadersInit — Kuito Documentation

Usage

Accept supported request-header formats.

tsx

// Accept supported request-header formats.
function authorized(token: string, extra: HeadersInit = {}): Headers {
  const headers = new Headers(extra);

  headers.set('Authorization', `Bearer ${token}`);

  return headers;
}

const response = await fetch('https://api.example.com/me', {
  headers: authorized('abc123', [['Accept', 'application/json']]),
});
const me = await response.json();

Type declaration

type HeadersInit = Headers | [string, string][] | Record<string, string>;

Members 4

Name	Type	Required	Description
`forEach`	`string \| ((callback: (value: string, name: string, headers: Headers) => void) => void) \| ((callbackfn: (value: [string, string], index: number, array: [string, string][]) => void, thisArg?: any) => void)`	Yes	Performs the specified action for each element in an array. @param callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.@param thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
`keys`	`string \| (() => string[]) \| (() => ArrayIterator<number>)`	Yes	Returns an iterable of keys in the array
`values`	`string \| (() => string[]) \| (() => ArrayIterator<[string, string]>)`	Yes	Returns an iterable of values in the array
`entries`	`string \| (() => [string, string][]) \| (() => ArrayIterator<[number, [string, string]]>)`	Yes	Returns an iterable of key, value pairs for every entry in the array

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.