netrc-parser

  • Version 3.1.6
  • Published
  • 13.7 kB
  • 2 dependencies
  • ISC license

Install

npm i netrc-parser
yarn add netrc-parser
pnpm add netrc-parser

Overview

netrc parser

Index

Variables

variable _default

const _default: Netrc;

    Functions

    function parse

    parse: (body: string) => Machines;

      Classes

      class Netrc

      class Netrc {}

        constructor

        constructor(file?: string);

          property file

          file: string;

            property machines

            machines: Machines;

              method load

              load: () => Promise<undefined>;

                method loadSync

                loadSync: () => undefined;

                  method save

                  save: () => Promise<{}>;

                    method saveSync

                    saveSync: () => void;

                      Type Aliases

                      type Machines

                      type Machines = {
                      [key: string]: {
                      login?: string;
                      password?: string;
                      account?: string;
                      [key: string]: string | undefined;
                      };
                      };

                        type MachineToken

                        type MachineToken = {
                        type: 'machine';
                        pre?: string;
                        host: string;
                        internalWhitespace: string;
                        props: {
                        [key: string]: {
                        value: string;
                        comment?: string;
                        };
                        };
                        comment?: string;
                        };

                          type Token

                          type Token =
                          | MachineToken
                          | {
                          type: 'other';
                          content: string;
                          };

                            Package Files (1)

                            Dependencies (2)

                            Dev Dependencies (11)

                            Peer Dependencies (0)

                            No peer dependencies.

                            Badge

                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/netrc-parser.

                            • Markdown
                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/netrc-parser)
                            • HTML
                              <a href="https://www.jsdocs.io/package/netrc-parser"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>