Class StoreClient

Hierarchy

BaseClient
- StoreClient

Index

Constructors

constructor

new StoreClient(config?: ClientConfig): StoreClient
Parameters
- Optionalconfig: ClientConfig
Returns StoreClient
Inherited from BaseClient.constructor
- Defined in client.ts:193

Properties

`Protected`apiUrl

apiUrl: string

`Protected`asyncCaller

asyncCaller: AsyncCaller

`Protected`defaultHeaders

defaultHeaders: Record<string, HeaderValue>

`Protected` `Optional`onRequest

onRequest?: RequestHook

`Protected`timeoutMs

timeoutMs: undefined | number

Methods

deleteItem

deleteItem(namespace: string[], key: string): Promise<void>
Delete an item.
Parameters
- namespace: string[]
  A list of strings representing the namespace path.
- key: string
  The unique identifier for the item.
Returns Promise<void>
Promise
- Defined in client.ts:1633

`Protected`fetch

fetch<T>(
    path: string,
    options: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse: true;
    },
): Promise<[T, Response]>
Type Parameters
- T
Parameters
- path: string
- options: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse: true;
  }
Returns Promise<[T, Response]>
Inherited from BaseClient.fetch
- Defined in client.ts:288
fetch<T>(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        signal?: AbortSignal;
        timeoutMs?: null | number;
        withResponse?: false;
    },
): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      signal?: AbortSignal;
      timeoutMs?: null | number;
      withResponse?: false;
  }
Returns Promise<T>
Inherited from BaseClient.fetch
- Defined in client.ts:299

getItem

getItem(
    namespace: string[],
    key: string,
    options?: { refreshTtl?: null | boolean },
): Promise<null | Item>
Retrieve a single item.
Parameters
- namespace: string[]
  A list of strings representing the namespace path.
- key: string
  The unique identifier for the item.
- Optionaloptions: { refreshTtl?: null | boolean }
  - OptionalrefreshTtl?: null | boolean
    Whether to refresh the TTL on this read operation. If null, uses the store's default behavior.
Returns Promise<null | Item>
Promise
Example
```
const item = await client.store.getItem(
  ["documents", "user123"],
  "item456",
  { refreshTtl: true }
);
console.log(item);
// {
//   namespace: ["documents", "user123"],
//   key: "item456",
//   value: { title: "My Document", content: "Hello World" },
//   createdAt: "2024-07-30T12:00:00Z",
//   updatedAt: "2024-07-30T12:00:00Z"
// }
```
- Defined in client.ts:1589

listNamespaces

listNamespaces(
    options?: {
        limit?: number;
        maxDepth?: number;
        offset?: number;
        prefix?: string[];
        suffix?: string[];
    },
): Promise<ListNamespaceResponse>
List namespaces with optional match conditions.
Parameters
- Optionaloptions: {
      limit?: number;
      maxDepth?: number;
      offset?: number;
      prefix?: string[];
      suffix?: string[];
  }
  - Optionallimit?: number
    Maximum number of namespaces to return (default is 100).
  - OptionalmaxDepth?: number
    Optional integer specifying the maximum depth of namespaces to return.
  - Optionaloffset?: number
    Number of namespaces to skip before returning results (default is 0).
  - Optionalprefix?: string[]
    Optional list of strings representing the prefix to filter namespaces.
  - Optionalsuffix?: string[]
    Optional list of strings representing the suffix to filter namespaces.
Returns Promise<ListNamespaceResponse>
Promise
- Defined in client.ts:1729

`Protected`prepareFetchOptions

prepareFetchOptions(
    path: string,
    options?: RequestInit & {
        json?: unknown;
        params?: Record<string, unknown>;
        timeoutMs?: null | number;
        withResponse?: boolean;
    },
): [url: URL, init: RequestInit]
Parameters
- path: string
- Optionaloptions: RequestInit & {
      json?: unknown;
      params?: Record<string, unknown>;
      timeoutMs?: null | number;
      withResponse?: boolean;
  }
Returns [url: URL, init: RequestInit]
Inherited from BaseClient.prepareFetchOptions
- Defined in client.ts:233

putItem

putItem(
    namespace: string[],
    key: string,
    value: Record<string, unknown>,
    options?: { index?: null | false | string[]; ttl?: null | number },
): Promise<void>
Store or update an item.
Parameters
- namespace: string[]
  A list of strings representing the namespace path.
- key: string
  The unique identifier for the item within the namespace.
- value: Record<string, unknown>
  A dictionary containing the item's data.
- Optionaloptions: { index?: null | false | string[]; ttl?: null | number }
  - Optionalindex?: null | false | string[]
    Controls search indexing - null (use defaults), false (disable), or list of field paths to index.
  - Optionalttl?: null | number
    Optional time-to-live in minutes for the item, or null for no expiration.
Returns Promise<void>
Promise
Example
```
await client.store.putItem(
  ["documents", "user123"],
  "item456",
  { title: "My Document", content: "Hello World" },
  { ttl: 60 } // expires in 60 minutes
);
```
- Defined in client.ts:1533

searchItems

searchItems(
    namespacePrefix: string[],
    options?: {
        filter?: Record<string, unknown>;
        limit?: number;
        offset?: number;
        query?: string;
        refreshTtl?: null | boolean;
    },
): Promise<SearchItemsResponse>
Search for items within a namespace prefix.
Parameters
- namespacePrefix: string[]
  List of strings representing the namespace prefix.
- Optionaloptions: {
      filter?: Record<string, unknown>;
      limit?: number;
      offset?: number;
      query?: string;
      refreshTtl?: null | boolean;
  }
  - Optionalfilter?: Record<string, unknown>
    Optional dictionary of key-value pairs to filter results.
  - Optionallimit?: number
    Maximum number of items to return (default is 10).
  - Optionaloffset?: number
    Number of items to skip before returning results (default is 0).
  - Optionalquery?: string
    Optional search query.
  - OptionalrefreshTtl?: null | boolean
    Whether to refresh the TTL on items returned by this search. If null, uses the store's default behavior.
Returns Promise<SearchItemsResponse>
Promise
Example
```
const results = await client.store.searchItems(
  ["documents"],
  {
    filter: { author: "John Doe" },
    limit: 5,
    refreshTtl: true
  }
);
console.log(results);
// {
//   items: [
//     {
//       namespace: ["documents", "user123"],
//       key: "item789",
//       value: { title: "Another Document", author: "John Doe" },
//       createdAt: "2024-07-30T12:00:00Z",
//       updatedAt: "2024-07-30T12:00:00Z"
//     },
//     // ... additional items ...
//   ]
// }
```
- Defined in client.ts:1684

Class StoreClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StoreClient

Properties

ProtectedapiUrl

ProtectedasyncCaller

ProtecteddefaultHeaders

Protected OptionalonRequest

ProtectedtimeoutMs

Methods

deleteItem

Parameters

Returns Promise<void>

Protectedfetch

Type Parameters

Parameters

Returns Promise<[T, Response]>

Type Parameters

Parameters

Returns Promise<T>

getItem

Parameters

OptionalrefreshTtl?: null | boolean

Returns Promise<null | Item>

Example

listNamespaces

Parameters

Optionallimit?: number

OptionalmaxDepth?: number

Optionaloffset?: number

Optionalprefix?: string[]

Optionalsuffix?: string[]

Returns Promise<ListNamespaceResponse>

ProtectedprepareFetchOptions

Parameters

Returns [url: URL, init: RequestInit]

putItem

Parameters

Optionalindex?: null | false | string[]

Optionalttl?: null | number

Returns Promise<void>

Example

searchItems

Parameters

Optionalfilter?: Record<string, unknown>

Optionallimit?: number

Optionaloffset?: number

Optionalquery?: string

OptionalrefreshTtl?: null | boolean

Returns Promise<SearchItemsResponse>

Example

Settings

On This Page

`Protected`apiUrl

`Protected`asyncCaller

`Protected`defaultHeaders

`Protected` `Optional`onRequest

`Protected`timeoutMs

`Protected`fetch

`Optional`refreshTtl?: null | boolean

`Optional`limit?: number

`Optional`maxDepth?: number

`Optional`offset?: number

`Optional`prefix?: string[]

`Optional`suffix?: string[]

`Protected`prepareFetchOptions

`Optional`index?: null | false | string[]

`Optional`ttl?: null | number

`Optional`filter?: Record<string, unknown>

`Optional`limit?: number

`Optional`offset?: number

`Optional`query?: string

`Optional`refreshTtl?: null | boolean