@trenskow/object-http-header-value

A small library for encoding objects into HTTP headers.

Usage

Use the library as the example below.

import { decode, encode } from '@trenskow/object-http-header-value';

const headerValue = encode({
	first: 'one',
	second: 'two'
}); // Returns 'First=one; Second=two'

const value = decode(
	'First=one; Second=two'
); // Returns { first: 'one', second: 'two' }

Options

These options are supported.

| Key | Type | Description | Default | Support | | ------------------- | :-------------------: | ------------------------------------------------------------ | :-------: | :-----------: | | keyCasing | String | A string that determines the way the keys are encoded (in string when encoding and object when decoding). Available casing is the same as @trenskow/caseit. When no option is provided no key casing transform will be done. | | Encode/Decode | | undefinedValues | 'keep' or 'strip' | Keep or strip keys which values are undefined. | 'strip' | Encode | | delimiter.value | String | The delimiter used to separate key-value pairs in the HTTP header value. | ; | Encode/Decode | | delimiter.item | String | The delimiter used to separate multiple objects if an array is provided. | , | Encode/Decode | | delimiter.key | String | The delimiter to use when dealing with nested objects. | . | Encode/Decode | | autoWrap | Boolean | Wrap in array when decoding only one item. | false | Decode |

License

See license in LICENSE.