To access data from within an EdgeWorkers function, you need to use the JavaScript helper library provided by ​Akamai​. This library uses an EdgeWorkers HTTP sub-request within an EdgeWorkers event handler to access EdgeKV data. For more information about the limits that apply to sub-requests, refer to the EdgeWorkers Resource tier limitations.

Enhanced token workflow

You need version 0.6.2 or higher of the JavaScript helper library in your EdgeWorkers code bundle to enable the enhanced token workflow capability.

📘

Any tokens created before the token workflow enhancement was activated are not compatible with version 0.6.2 of the JavaScript helper library. For instructions on how to update your code bundle go to, Create a code bundle.

Supported operations

Review the table below for details about the supported operations and EdgeKV JavaScript APIs for each event handler.

To learn more about the specific HTTP events that can execute an EdgeWorkers script go to the Event handler functions section in the EdgeWorkers documentation.

Error format

When an operation is not successful an error object in the following format is thrown.

{
	"failed": "whatFailed",
	"status": responseStatusCode,
	"body": "descriptionOfFailure"
}

Constructor

Use this Constructor to set the default namespace and group. You can make individual GET, PUT, and DELETE operations to override these default values.

new EdgeKV(namespace = "default", group = "default", num_retries_on_timeout = 0)

Library helper methods

getText()

Gets a text value from an item in the EdgeKV database (async).

Parameters

async getText({ namespace = this.#namespace, group = this.#group, item, default_value = null, timeout = null })

📘

Each retry request is a separate, billable read request. Retry requests are not available for write (PUT) or delete (DELETE) requests. If you do not require confirmation when a request completes, you should use the NoWait variants, putTextNoWait(), putJsonNoWait(), and deleteNoWait() to avoid any EdgeWorkers timeout issues.

try {
	const edgeKv = new EdgeKV({ group: "ProductSalePrice" }); // the namespace will be "default" since it is not provided
	let salePrice = await edgeKv.getText({ item: productId, default_value: "N/A" });
	// use the salePrice in the page
} catch (error) {
	// do something in case of an error
}

getJson()

Gets a JSON value from an item in the EdgeKV database (async).

Parameters

getJson({ namespace = this.#namespace, group = this.#group, item, default_value = null, timeout = null, num_retries_on_timeout = null})

📘

Each retry request is a separate, billable read request. Retry requests are not available for write (PUT) or delete (DELETE) requests. If you do not require confirmation when a request completes, you should use the NoWait variants, putTextNoWait(), putJsonNoWait(), and deleteNoWait() to avoid any EdgeWorkers timeout issues.

putText()

Asynchronously inserts a text value into an item if it does not already exist, or updates a value if it does exist (upsert).

Parameters

putText({ namespace = this.#namespace, group = this.#group, item, value, timeout = null })

try {
	const edgeKv = new EdgeKV({ group: "LastUpdated" });
	let date = new Date().toString();
	await edgeKv.putText({ item: productId, value: date });
	// this information can then be used to see when a product was last updated
} catch (error) {
	// do something in case of an error
}

putTextNoWait()

Upserts a text value into an item in the EdgeKV database while only waiting for the request to send and not for the response.

Parameters

putTextNoWait({ namespace = this.#namespace, group = this.#group, item, value })

try {
	const edgeKv = new EdgeKV({ group: "LastUpdated" });
	let date = new Date().toString();
	edgeKv.putTextNoWait({ item: productId, value: date });
	// this information can then be used to see when a product was last updated
} catch (error) {
	// do something in case of an error
}

putJson()

Upserts a JSON value into an item in the EdgeKV database (async).

Parameters

putJson({ namespace = this.#namespace, group = this.#group, item, value, timeout = null })

try {
	const edgeKv = new EdgeKV({ group: "LastUpdated" });
	let obj = {prop1:"someValue",prop2:42};
	await edgeKv.putJson({ item: productId, value: obj });
	// this json object can later be pulled out using getJson
} catch (error) {
	// do something in case of an error
}

putJsonNoWait()

Upserts a JSON value into an item in the EdgeKV database while only waiting for the request to send and not for the response.

Parameters

putJsonNoWait({ namespace = this.#namespace, group = this.#group, item, value })

try {
	const edgeKv = new EdgeKV({ group: "LastUpdated" });
	let obj = {prop1:"someValue",prop2:42};
	edgeKv.putJsonNoWait({ item: productId, value: obj });
	// this json object can later be pulled out using getJson
} catch (error) {
	// do something in case of an error
}

delete()

Deletes the named item from the EdgeKV database.

Parameters

delete({ namespace = this.#namespace, group = this.#group, item, timeout = null })

try {
	const edgeKv = new EdgeKV({ group: "LastUpdated" });
	await edgeKv.delete({ item: productId });
} catch (error) {
	// do something in case of an error
}

deleteNoWait()

Deletes the named item from the EdgeKV database while only waiting for the request to send and not for the response.

Parameters

deleteNoWait({ namespace = this.#namespace, group = this.#group, item } = {}) {

try {
    const edgeKv = new EdgeKV({ group: "LastUpdated" });
    edgeKv.deleteNoWait({ item: productId });
} catch (error) {
    // do something in case of an error
}