Get started

const vault = client.Vault({ name: 'My vault' });
await vault.addCredentials('https://github.com/', { email: 'me@example.org', password: 'secret' }); // pragma: allowlist secret
const credentials = await vault.getCredentials('https://github.com/login');
await vault.stop(); // deletes the vault and every credential it holds

​

Create NotteVault

client.Vault(options?: VaultConstructor): NotteVault;

​

Related types

• VaultConstructor

​

Usage

• addCredentials: Add or update the credentials stored for a website. Values are sent as supplied; the API validates credentials and reduces the URL to its root domain (https://github.com/login → github.com).
• getCredentials: Get the credentials stored for a website. Rejects with a NotteAPIError when the vault holds no credentials for that domain, like Python’s get_credentials.
• deleteCredentials: Delete the credentials stored for a website.
• listCredentials: List the websites the vault holds credentials for. Passwords are never returned.
• generatePassword: Generate a secure random password, the counterpart of Python’s generate_password. The result always contains a lowercase letter, an uppercase letter and a digit, plus a special character unless includeSpecialChars is false.
• hasCredential: Check whether the vault holds credentials for a website, the counterpart of BaseVault.has_credential. Never rejects for a missing credential.

new NotteVault(client: NotteClient, options?: VaultConstructor): NotteVault;

{}

vaultId: string