UNPKG

1.53 kBTypeScriptView Raw
1import * as Token from './token';
2/**
3 * parses a netrc file
4 */
5export declare class Netrc extends Token.Base {
6 /**
7 * generates or parses a netrc file
8 * @example
9 * const {Netrc} = require('netrc-parser')
10 * const netrc = new Netrc()
11 * netrc.machines['api.heroku.com'].password // get auth token from ~/.netrc
12 */
13 constructor(file?: string);
14 private _file;
15 protected _tokens: Token.Token[];
16 readonly file: string;
17 readonly machines: Token.Machines;
18 private _machines;
19 default: Token.IMachine | undefined;
20 load(): Promise<void>;
21 loadSync(): void;
22 /**
23 * save the current home netrc with any changes
24 * @example
25 * const Netrc = require('netrc-parser')
26 * const netrc = new Netrc()
27 * await netrc.load()
28 * netrc.machines['api.heroku.com'].password = 'newpassword'
29 * netrc.save()
30 */
31 save(): Promise<{}>;
32 /**
33 * save the current home netrc with any changes
34 * @example
35 * const Netrc = require('netrc-parser')
36 * const netrc = new Netrc()
37 * netrc.loadSync()
38 * netrc.machines['api.heroku.com'].password = 'newpassword'
39 * netrc.saveSync()
40 */
41 saveSync(): void;
42 private readonly gpgEncryptArgs;
43 private write(body);
44 private writeSync(body);
45 private parse(body);
46 private readonly gpgDecryptArgs;
47 private readFile();
48 private readFileSync();
49 private readonly homedir;
50 private defaultFile();
51}
52declare const _default: Netrc;
53export default _default;