near-sdk-js/lib/collections/lookup-set.js

High Level JavaScript SDK for building smart contracts on NEAR

import * as near from "../api";
import { serializeValueWithOptions } from "../utils";
/**
 * A lookup set collection that stores entries in NEAR storage.
 */
export class LookupSet {
    /**
     * @param keyPrefix - The byte prefix to use when storing elements inside this collection.
     */
    constructor(keyPrefix) {
        this.keyPrefix = keyPrefix;
    }
    /**
     * Checks whether the collection contains the value.
     *
     * @param key - The value for which to check the presence.
     * @param options - Options for storing data.
     */
    contains(key, options) {
        const storageKey = this.keyPrefix + serializeValueWithOptions(key, options);
        return near.storageHasKey(storageKey);
    }
    /**
     * Returns true if the element was present in the set.
     *
     * @param key - The entry to remove.
     * @param options - Options for storing data.
     */
    remove(key, options) {
        const storageKey = this.keyPrefix + serializeValueWithOptions(key, options);
        return near.storageRemove(storageKey);
    }
    /**
     * If the set did not have this value present, `true` is returned.
     * If the set did have this value present, `false` is returned.
     *
     * @param key - The value to store in the collection.
     * @param options - Options for storing the data.
     */
    set(key, options) {
        const storageKey = this.keyPrefix + serializeValueWithOptions(key, options);
        return !near.storageWrite(storageKey, "");
    }
    /**
     * Extends the current collection with the passed in array of elements.
     *
     * @param keys - The elements to extend the collection with.
     * @param options - Options for storing the data.
     */
    extend(keys, options) {
        keys.forEach((key) => this.set(key, options));
    }
    /**
     * Serialize the collection.
     *
     * @param options - Options for storing the data.
     */
    serialize(options) {
        return serializeValueWithOptions(this, options);
    }
    /**
     * Converts the deserialized data from storage to a JavaScript instance of the collection.
     *
     * @param data - The deserialized data to create an instance from.
     */
    static reconstruct(data) {
        return new LookupSet(data.keyPrefix);
    }
}