Class: NameManager

Constructor

new NameManager(clientKey, clientSecret)

Creates a new instance of the constructor.

Parameters:

Name	Type	Description
`clientKey`	string	The access key ID for authentication.
`clientSecret`	string	The secret access key for authentication.

Source: nameManager.js, line 5
Tutorials: Names

Example

import { NameManager } from "@filebase/sdk";
const nameManager = new NameManager("KEY_FROM_DASHBOARD", "SECRET_FROM_DASHBOARD");

Methods

(async) create(label, cid, optionsopt) → {Promise.<name>}

Creates a new IPNS name with the given name as the label and CID.

Parameters:

Name	Type	Attributes	Description
`label`	string		The label of the new IPNS name.
`cid`	string		The CID of the IPNS name.
`options`	nameOptions	<optional>	Additional options for the IPNS name.

Source: nameManager.js, line 63

Returns:

A Promise that resolves with the response JSON.

Type:: Promise.<name>

Example

// Create IPNS name with label of `create-name-example` and CID of `QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm`
await nameManager.create(`create-name-example`, `QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm`);

(async) import(label, cid, privateKey, optionsopt) → {Promise.<name>}

Imports a user's IPNS private key.

Parameters:

Name	Type	Attributes	Description
`label`	string		The label for the IPNS name.
`cid`	string		The CID (Content Identifier) of the data.
`privateKey`	string		The existing private key encoded in Base64.
`options`	nameOptions	<optional>	Additional options for the IPNS name.

Source: nameManager.js, line 101

Returns:

A Promise that resolves to the server response.

Type:: Promise.<name>

Example

// Import IPNS private key with label of `create-name-example`, CID of `QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm`
// and a private key encoded with base64
await nameManager.import(
 `create-name-example`,
 `QmdmQXB2mzChmMeKY47C43LxUdg1NDJ5MWcKMKxDu7RgQm`
 `BASE64_ENCODED_PRIVATEKEY`
);

(async) update(label, cid, options) → {Promise.<boolean>}

Updates the specified name with the given CID.

Parameters:

Name	Type	Description
`label`	string	The label of the name to update.
`cid`	string	The cid to associate with the name.
`options`	nameOptions	The options for the set operation.

Source: nameManager.js, line 136

Returns:

A Promise that resolves to true if the IPNS name was updated.

Type:: Promise.<boolean>

Example

// Update name with label of `update-name-example` and set the value of the IPNS name.
await nameManager.update(`update-name-example`, `bafybeidt4nmaci476lyon2mvgfmwyzysdazienhxs2bqnfpdainzjuwjom`);

(async) get(label) → {Promise.<name>}

Returns the value of an IPNS name

Parameters:

Name	Type	Description
`label`	string	Parameter representing the label of the name to resolve.

Source: nameManager.js, line 166

Returns:

A promise that resolves to the value of a name.

Type:: Promise.<name>

Example

// Get IPNS name with label of `list-name-example`
await nameManager.get(`list-name-example`);

(async) list() → {Promise.<Array.<name>>}

Returns a list of IPNS names

Source: nameManager.js, line 188

Returns:

A promise that resolves to an array of names.

Type:: Promise.<Array.<name>>

Example

// List all IPNS names
await nameManager.list();

(async) delete(label) → {Promise.<boolean>}

Deletes an IPNS name with the given label.

Parameters:

Name	Type	Description
`label`	string	The label of the IPNS name to delete.

Source: nameManager.js, line 207

Returns:

A promise that resolves to true if the IPNS name was successfully deleted.

Type:: Promise.<boolean>

Example

// List IPNS name with label of `delete-name-example`
await nameManager.delete(`delete-name-example`);

(async) toggle(label, targetState) → {Promise.<boolean>}

Toggles the enabled state of a given IPNS name.

Parameters:

Name	Type	Description
`label`	string	The label of the IPNS name to toggle.
`targetState`	boolean	The new target state.

Source: nameManager.js, line 232

Returns:

A promise that resolves to true if the IPNS name was successfully toggled.

Type:: Promise.<boolean>

Example

// Toggle IPNS name with label of `toggle-name-example`
await nameManager.toggle(`toggle-name-example`, true);  // Enabled
await nameManager.toggle(`toggle-name-example`, false); // Disabled