@launchdarkly/fastly-server-sdk - v0.2.39
    Preparing search index...

    Interface KVStore

    Class for accessing a Fastly KV store.

    A KV store is a persistent, globally consistent key-value store. See Data stores for Fastly services for initialization and usage details.

    Note: Can only be used when processing requests, not during build-time initialization.

    In this example we connect to a KV store named 'files', save an entry to the store under the key 'hello' and then read back the value and return it to the client.

    /// <reference types="@fastly/js-compute" />

    import { KVStore } from "fastly:kv-store";

    async function app(event) {
      const files = new KVStore('files')

      await files.put('hello', 'world')

      const entry = await files.get('hello')

      return new Response(await entry.text())
    }

    addEventListener("fetch", (event) => event.respondWith(app(event)))
    interface KVStore {
        delete(key: string): Promise<undefined>;
        get(key: string): Promise<KVStoreEntry | null>;
        list(
            options?: {
                cursor?: string;
                limit?: number;
                noSync?: boolean;
                prefix?: string;
            },
        ): Promise<{ cursor: string | undefined; list: string[] }>;
        put(
            key: string,
            value: BodyInit,
            options?: {
                gen?: number;
                metadata?: string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>;
                mode?: "overwrite" | "add" | "append" | "prepend";
                ttl?: number;
            },
        ): Promise<undefined>;
    }
    Index
    delete get list put

    • Delete the value associated with the key key in the KV store.

      Parameters

      • key: string

        The key to delete from within the KV store. A key cannot:

        • Be any of the strings "", ".", or ".."
        • Start with the string ".well-known/acme-challenge/"
        • Contain any of the characters "#;?^|\n\r"
        • Be longer than 1024 characters

      Returns Promise<undefined>

      TypeError if the key violates any of the above constraints.

      3.13.0

    • Gets the value associated with the key key in the KV store.

      When the key is present, a resolved Promise containing a KVStoreEntry will be returned which contains the associated value. When the key is absent, a resolved Promise containing null is returned.

      Parameters

      • key: string

        The key to retrieve from within the KV store. A key cannot:

        • Be any of the strings "", ".", or ".."
        • Start with the string ".well-known/acme-challenge/"
        • Contain any of the characters "#;?^|\n\r"
        • Be longer than 1024 characters

      Returns Promise<KVStoreEntry | null>

      Throws TypeError if the key violates any of the above constraints.

    • List keys in the KV store, optionally filtered by prefix.

      Parameters

      • Optionaloptions: { cursor?: string; limit?: number; noSync?: boolean; prefix?: string }

        Options for filtering and paginating the key list.

        • Optionalcursor?: string

          The base64 cursor string representing the last listing operation.

        • Optionallimit?: number

          Limit the number of keys provided per listing.

        • OptionalnoSync?: boolean

          Do not wait to sync the key list, and instead immediately return the current cached key list. May be faster but possibly out of date.

        • Optionalprefix?: string

          String prefix for keys to list.

      Returns Promise<{ cursor: string | undefined; list: string[] }>

      A Promise resolving with the list of keys and a cursor for pagination.

      3.26.0

    • Write the value of value into the KV store under the key key.

      Note: KV store is eventually consistent, this means that the updated contents associated with the key key may not be available to read from all edge locations immediately and some edge locations may continue returning the previous contents associated with the key.

      Parameters

      • key: string

        The key to associate with the value in the KV store. A key cannot:

        • Be any of the strings "", ".", or ".."
        • Start with the string ".well-known/acme-challenge/"
        • Contain any of the characters "#;?^|\n\r"
        • Be longer than 1024 characters
      • value: BodyInit

        The value to store within the KV store. Maximum size is 30 MB.

      • Optionaloptions: {
            gen?: number;
            metadata?: string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>;
            mode?: "overwrite" | "add" | "append" | "prepend";
            ttl?: number;
        }
        • Optionalgen?: number

          Generation counter for conditional writes. The write only succeeds if the current generation of the entry matches this value. Must be a positive integer.

          3.31.0

        • Optionalmetadata?: string | ArrayBuffer | ArrayBufferView<ArrayBufferLike>

          Binary metadata to associate with the entry, up to 1000 bytes.

          If passing a string, UTF-8 encoding is used.

          3.26.0

        • Optionalmode?: "overwrite" | "add" | "append" | "prepend"

          Insert mode, defaults to 'overwrite'.

          • 'overwrite': Replace any existing value for the key.
          • 'add': Only insert if the key does not already exist.
          • 'append': Append to any existing value for the key.
          • 'prepend': Prepend to any existing value for the key.

          3.26.0

        • Optionalttl?: number

          TTL (time-to-live) for the entry, in seconds.

          3.26.0

      Returns Promise<undefined>

      TypeError if the key violates any of the above constraints or if gen is provided and is not a positive integer.

    Settings
    Member Visibility

    On This Page
    Methods