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

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.js";
import { APIPromise } from "../../../core/api-promise.js";
import { RequestOptions } from "../../../internal/request-options.js";
export declare class BaseMetadata extends APIResource {
    static readonly _key: readonly ['kv', 'namespaces', 'metadata'];
    /**
     * Returns the JSON metadata associated with the specified key in the Workers KV
     * namespace, without retrieving its value. Use URL-encoding for special characters
     * (for example, `:`, `!`, `%`) in the key name when constructing the request URL.
     *
     * @example
     * ```ts
     * const metadata = await client.kv.namespaces.metadata.get(
     *   'My-Key',
     *   {
     *     account_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *     namespace_id: '0f2ac74b498b48028cb68387c421e279',
     *   },
     * );
     * ```
     */
    get(keyName: string, params: MetadataGetParams, options?: RequestOptions): APIPromise<MetadataGetResponse>;
}
export declare class Metadata extends BaseMetadata {
}
/**
 * Arbitrary JSON that is associated with a key.
 */
export type MetadataGetResponse = unknown;
export interface MetadataGetParams {
    /**
     * ID of the Cloudflare account that owns the Workers KV namespaces.
     */
    account_id: string;
    /**
     * ID of the Workers KV namespace.
     */
    namespace_id: string;
}
export declare namespace Metadata {
    export { type MetadataGetResponse as MetadataGetResponse, type MetadataGetParams as MetadataGetParams };
}
//# sourceMappingURL=metadata.d.ts.map