Class PropertyStore<T>

Generic store for request properties (headers, params).

Handles CRUD operations, method-specific overrides, and merging for requests. This class is used internally by FetchEngine to manage both headers and params with a unified API.

Properties are resolved in order:

Instance defaults
Method-specific overrides
Request-level overrides

Example

const headers = new PropertyStore<Headers>({
    defaults: { 'Content-Type': 'application/json' },
    methodOverrides: {
        POST: { 'X-Custom': 'post-only' }
    }
});

// Add header globally
headers.set('Authorization', 'Bearer token');

// Add header for specific method
headers.set('X-Request-ID', 'abc', 'POST');

// Resolve headers for a request
const resolved = headers.resolve('POST', { 'X-Override': 'value' });

Type Parameters

T extends Record<string, unknown>
The property type (e.g., Record<string, string>)

Index

Constructors

constructor

new PropertyStore<T extends Record<string, unknown>>(
options?: PropertyStoreOptions<T>,
): PropertyStore<T>
Type Parameters
- T extends Record<string, unknown>
  The property type (e.g., Record<string, string>)
Parameters
- options: PropertyStoreOptions<T> = {}
Returns PropertyStore<T>
- Defined in packages/fetch/src/properties/store.ts:80

Accessors

all

get all(): { default: T } & Record<string, Partial<T>>
Get all values including method overrides.

Returns an object with 'default' key for defaults and method names as keys for method-specific overrides.

Returns { default: T } & Record<string, Partial<T>>
Object with all property values
Example
```
const all = headers.all;
// { default: { Authorization: '...' }, POST: { 'X-Custom': '...' } }
```
- Defined in packages/fetch/src/properties/store.ts:300

defaults

get defaults(): T
Get the default values (without method overrides).

Returns T
Clone of the default values
Example
```
const defaultHeaders = headers.defaults;
```
- Defined in packages/fetch/src/properties/store.ts:282

Methods

forMethod

forMethod(method: string): Partial<T>
Get method-specific overrides only (not merged with defaults).
Parameters
- method: string
  HTTP method
Returns Partial<T>
Method-specific overrides or empty object
Example
```
const postHeaders = headers.forMethod('POST');
```
- Defined in packages/fetch/src/properties/store.ts:324

has

has(key: string, method?: string): boolean
Check if a property exists globally or for a specific method.
Parameters
- key: string
  Property key to check
- Optionalmethod: string
  Optional HTTP method to check method-specific value
Returns boolean
True if the property exists
Example
```
if (headers.has('Authorization')) {
    console.log('Auth header is set');
}
```
- Defined in packages/fetch/src/properties/store.ts:256

remove

remove(key: string, method?: string): void
Remove a property globally or for a specific method.
Parameters
- key: string
  Property key to remove
- Optionalmethod: string
  Optional HTTP method for method-specific removal
Returns void
Example
```
headers.remove('Authorization');
headers.remove('X-Custom', 'POST');
```
- Defined in packages/fetch/src/properties/store.ts:203
remove(keys: string[], method?: string): void
Remove multiple properties globally or for a specific method.
Parameters
- keys: string[]
  Array of property keys to remove
- Optionalmethod: string
  Optional HTTP method for method-specific removal
Returns void
Example
```
headers.remove(['Authorization', 'X-API-Key']);
headers.remove(['X-Custom', 'X-Other'], 'POST');
```
- Defined in packages/fetch/src/properties/store.ts:215

resolve

resolve(method: string, requestOverrides?: Partial<T>): T
Resolve the final property values for a specific method.

Merges in order: defaults → method overrides → request overrides.
Parameters
- method: string
  HTTP method
- OptionalrequestOverrides: Partial<T>
  Request-level overrides (highest priority)
Returns T
Merged property values
Example
```
const headers = this.headers.resolve('POST', { 'X-Request-ID': '123' });
```
- Defined in packages/fetch/src/properties/store.ts:345

set

set(key: string, value: unknown, method?: string): void
Set a property value globally or for a specific method.
Parameters
- key: string
  Property key
- value: unknown
  Property value
- Optionalmethod: string
  Optional HTTP method for method-specific override
Returns void
Example
```
headers.set('Authorization', 'Bearer token');
headers.set('X-Custom', 'value', 'POST');
```
- Defined in packages/fetch/src/properties/store.ts:110
set(values: Partial<T>, method?: string): void
Set multiple property values globally or for a specific method.
Parameters
- values: Partial<T>
  Object with key-value pairs to set
- Optionalmethod: string
  Optional HTTP method for method-specific overrides
Returns void
Example
```
headers.set({ 'Authorization': 'Bearer token', 'X-API-Key': 'abc' });
headers.set({ 'X-Custom': 'value' }, 'POST');
```
- Defined in packages/fetch/src/properties/store.ts:122

Class PropertyStore<T>

Example

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PropertyStore<T>

Accessors

all

Returns { default: T } & Record<string, Partial<T>>

Example

defaults

Returns T

Example

Methods

forMethod

Parameters

Returns Partial<T>

Example

has

Parameters

Returns boolean

Example

remove

Parameters

Returns void

Example

Parameters

Returns void

Example

resolve

Parameters

Returns T

Example

set

Parameters

Returns void

Example

Parameters

Returns void

Example

Settings

On This Page