Snelle referentie

Nopt optieparser spiekbriefje

Snelle referentiegids voor Nopt, de optieparser van npm voor Node.js: typedefinities, afkortingen, verwerking van resterende argv en validatie.

· Gepubliceerd

nopt is de optieparser die intern wordt gebruikt door npm en veel opdrachtregelprogramma's.

Basisgebruik

const nopt = require('nopt');

// 1. Define expected option types
const knownOpts = {
  foo: [String, null],
  size: ['big', 'medium', 'small'],
  many: [String, Array],
  debug: Boolean,
  version: Boolean,
  help: Boolean
};

// 2. Define short aliases
const shortHands = {
  h: '--help',
  v: '--version',
  d: '--debug'
};

// 3. Parse arguments
const parsed = nopt(knownOpts, shortHands, process.argv, 2);

Uitvoerstructuur

Gegeven het volgende CLI-commando:

node app.js --size big -d input1.txt input2.txt

Het resulterende geparste object:

{
  size: 'big',
  debug: true,
  argv: {
    remain: ['input1.txt', 'input2.txt'], // Non-option positional arguments
    cooked: ['--size', 'big', '--debug', 'input1.txt', 'input2.txt'],
    original: ['--size', 'big', '-d', 'input1.txt', 'input2.txt']
  }
}

Ondersteunde typen

  • String
  • Boolean
  • Number
  • Array
  • Date
  • path (normaliseert padstrings)
  • url (valideert URL-strings)
  • Opsommingen (Enums): ['small', 'medium', 'large']

Referenties

Verwante onderwerpen