set

Theset method is used to create or overwrite a piece of data.

async function set(
    key: string, 
    value: T
): Promise<Entry<T>>;

Reference

Overview

You can use set to create or overwrite a piece of data.

import { User } from "#elements";

...

await User.set("user-1", {
    name: "user-1",
    actived: true
});
...

Returns

The return value is a data object formed by merging the fields defined in the Database Element and the key.

Caveats

• The data returned by calling set filters out fields not defined in the Database Element.

Examples

set data to Database Element

The User Database Element defines two fields, name and actived. Here's an example of adding a piece of data to the Database Element in a Function Element.

import { User } from "#elements";

export default async function () {
    return await User.set("user-1", {
        name: "user-1",
        actived: true
    });
}

return value:

{
    "key": "user-1",
    "name": "user-1",
    "actived": true
}