npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

keytar-extra

v4.12.0

Published

Bindings to native Mac/Linux/Windows password APIs

Downloads

4

Readme

Keytar - Node module to manage system keychain

Travis Build Status Windows Build Status Dependency Status

A native Node module to get, add, replace, and delete passwords in system's keychain. On macOS the passwords are managed by the Keychain, on Linux they are managed by the Secret Service API/libsecret, and on Windows they are managed by Credential Vault.

Installing

npm install keytar-extra

On Linux

Currently this library uses libsecret so you may need to install it before running npm install.

Depending on your distribution, you will need to run the following command:

  • Debian/Ubuntu: sudo apt-get install libsecret-1-dev
  • Red Hat-based: sudo yum install libsecret-devel
  • Arch Linux: sudo pacman -S libsecret

Building

  • Clone the repository
  • Run npm install
  • Run npm test to run the tests

Docs

const keytar = require('keytar-extra')

Differences in Behavior

  • The asynchronous functions in Keytar return Promises, which resolve with data upon successful completion and reject with an error if one occurs.

  • The synchronous functions in Keytar return plain values, and throw errors when they encounter issues.


getPassword(service, account)

Get the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns a Promise yielding the string password, or null if an entry for the given service and account was not found.


getPasswordSync(service, account)

Get the stored password for the service and account.

service - The string service name.

account - The string account name.

Yields the string password or null if an entry for the given service and account was not found.


setPassword(service, account, password)

Save the password for the service and account to the keychain. Adds a new entry if necessary, or updates an existing entry if one exists.

service - The string service name.

account - The string account name.

password - The string password.

Returns a Promise yielding nothing, and resolving only after password has been set.


setPasswordSync(service, account, password)

Save the password for the service and account to the keychain. Adds a new entry if necessary, or updates an existing entry if one exists.

service - The string service name.

account - The string account name.

password - The string password.

Returns nothing.


deletePassword(service, account)

Delete the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns a Promise, resolving true if a password was deleted, or false if an entry with the given service and account was not found.


deletePasswordSync(service, account)

Delete the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns true if a password was deleted, or false if an entry with the given service and account was not found.


findCredentials(service)

Find all accounts and password for the service in the keychain.

service - The string service name.

Returns a Promise, resolving an array of { account: 'foo', password: 'bar' }.


findCredentialsSync(service)

Find all accounts and password for the service in the keychain.

service - The string service name.

Returns an array of { account: 'foo', password: 'bar' }.


findPassword(service)

Find a password for the service in the keychain. This is ideal for scenarios where an account is not required.

service - The string service name.

Returns a Promise, which resolves to the string password, or null if an entry for the given service was not found.


findPasswordSync(service)

Find a password for the service in the keychain. This is ideal for scenarios where an account is not required.

service - The string service name.

Returns the string password, or null if an entry for the given service was not found.

License [ MIT ]

Copyright (c) 2013 GitHub Inc.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.