cloudflare/resources/kv/namespaces/keys.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import { CursorLimitPagination, type CursorLimitPaginationParams } from "../../../pagination.js";
export declare class Keys extends APIResource {
    /**
     * Lists a namespace's keys.
     */
    list(namespaceId: string, params: KeyListParams, options?: Core.RequestOptions): Core.PagePromise<KeysCursorLimitPagination, Key>;
}
export declare class KeysCursorLimitPagination extends CursorLimitPagination<Key> {
}
/**
 * A name for a value. A value stored under a given key may be retrieved via the
 * same key.
 */
export interface Key {
    /**
     * A key's name. The name may be at most 512 bytes. All printable, non-whitespace
     * characters are valid. Use percent-encoding to define key names as part of a URL.
     */
    name: string;
    /**
     * The time, measured in number of seconds since the UNIX epoch, at which the key
     * will expire. This property is omitted for keys that will not expire.
     */
    expiration?: number;
    /**
     * Arbitrary JSON that is associated with a key.
     */
    metadata?: Record<string, unknown>;
}
export interface KeyListParams extends CursorLimitPaginationParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Query param: A string prefix used to filter down which keys will be returned.
     * Exact matches and any key names that begin with the prefix will be returned.
     */
    prefix?: string;
}
export declare namespace Keys {
    export { type Key as Key, KeysCursorLimitPagination as KeysCursorLimitPagination, type KeyListParams as KeyListParams, };
}
//# sourceMappingURL=keys.d.ts.map