cloudflare
Version:
The official TypeScript library for the Cloudflare API
93 lines • 4.2 kB
JavaScript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from "../../../core/resource.mjs";
import { buildHeaders } from "../../../internal/headers.mjs";
import { multipartFormRequestOptions } from "../../../internal/uploads.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BaseValues = /* @__PURE__ */ (() => {
class BaseValues extends APIResource {
/**
* Writes a value under the specified key in the Workers KV namespace, creating the
* key-value pair or replacing its existing value, expiration, and metadata. Send
* the value as an `application/octet-stream` request body, or use
* `multipart/form-data` with a `value` part and an optional JSON `metadata` part.
* Use URL-encoding for special characters (for example, `:`, `!`, `%`) in the key
* name when constructing the request URL. If neither `expiration` nor
* `expiration_ttl` is specified, the key-value pair will not expire. If both are
* set, `expiration_ttl` takes precedence.
*
* @example
* ```ts
* const value = await client.kv.namespaces.values.update(
* 'My-Key',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* namespace_id: '0f2ac74b498b48028cb68387c421e279',
* value: 'Some Value',
* },
* );
* ```
*/
update(keyName, params, options) {
const { account_id, namespace_id, expiration, expiration_ttl, ...body } = params;
return this._client.put(path `/accounts/${account_id}/storage/kv/namespaces/${namespace_id}/values/${keyName}`, multipartFormRequestOptions({ query: { expiration, expiration_ttl }, body, ...options }, this._client))._thenUnwrap((obj) => obj.result);
}
/**
* Deletes the specified key and its value from the Workers KV namespace. Use
* URL-encoding for special characters (for example, `:`, `!`, `%`) in the key name
* when constructing the request URL.
*
* @example
* ```ts
* const value = await client.kv.namespaces.values.delete(
* 'My-Key',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* namespace_id: '0f2ac74b498b48028cb68387c421e279',
* },
* );
* ```
*/
delete(keyName, params, options) {
const { account_id, namespace_id } = params;
return this._client.delete(path `/accounts/${account_id}/storage/kv/namespaces/${namespace_id}/values/${keyName}`, options)._thenUnwrap((obj) => obj.result);
}
/**
* Returns the value stored under the specified key in the Workers KV namespace as
* raw bytes. Use URL-encoding for special characters (for example, `:`, `!`, `%`)
* in the key name when constructing the request URL. If the key-value pair
* expires, the `expiration` response header contains its expiration time in
* seconds since the UNIX epoch.
*
* @example
* ```ts
* const value = await client.kv.namespaces.values.get(
* 'My-Key',
* {
* account_id: '023e105f4ecef8ad9ca31a8372d0c353',
* namespace_id: '0f2ac74b498b48028cb68387c421e279',
* },
* );
*
* const content = await value.blob();
* console.log(content);
* ```
*/
get(keyName, params, options) {
const { account_id, namespace_id } = params;
return this._client.get(path `/accounts/${account_id}/storage/kv/namespaces/${namespace_id}/values/${keyName}`, {
...options,
headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
__binaryResponse: true,
});
}
}
BaseValues._key = Object.freeze([
'kv',
'namespaces',
'values',
]);
return BaseValues;
})();
export class Values extends BaseValues {
}
//# sourceMappingURL=values.mjs.map