mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-11 19:42:23 +08:00
1ed019e8ad
* Updating keytar typings for v4.0.2 * Updating the return types * Adding null return for get/find password
46 lines
1.5 KiB
TypeScript
46 lines
1.5 KiB
TypeScript
// Type definitions for keytar 4.0.2
|
|
// Project: http://atom.github.io/node-keytar/
|
|
// Definitions by: Milan Burda <https://github.com/miniak/>, Brendan Forster <https://github.com/shiftkey/>, Hari Juturu <https://github.com/juturu/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
|
|
/**
|
|
* Get the stored password for the service and account.
|
|
*
|
|
* @param service The string service name.
|
|
* @param account The string account name.
|
|
*
|
|
* @returns A promise for the password string.
|
|
*/
|
|
export declare function getPassword(service: string, account: string): Promise<string | null>;
|
|
|
|
/**
|
|
* Add the password for the service and account to the keychain.
|
|
*
|
|
* @param service The string service name.
|
|
* @param account The string account name.
|
|
* @param password The string password.
|
|
*
|
|
* @returns A promise for the set password completion.
|
|
*/
|
|
export declare function setPassword(service: string, account: string, password: string): Promise<void>;
|
|
|
|
/**
|
|
* Delete the stored password for the service and account.
|
|
*
|
|
* @param service The string service name.
|
|
* @param account The string account name.
|
|
*
|
|
* @returns A promise for the deletion status. True on success.
|
|
*/
|
|
export declare function deletePassword(service: string, account: string): Promise<boolean>;
|
|
|
|
/**
|
|
* Find a password for the service in the keychain.
|
|
*
|
|
* @param service The string service name.
|
|
*
|
|
* @returns A promise for the password string.
|
|
*/
|
|
export declare function findPassword(service: string): Promise<string | null>;
|