command-line-args/example/type.js

'use strict'
const commandLineArgs = require('../')

/* demonstrates a custom `type` function which returns a class instance */

class FileDetails {
  constructor (filename) {
    const fs = require('fs')
    this.filename = filename
    this.exists = fs.existsSync(filename)
  }
}

const optionDefinitions = [
  {
    name: 'file',
    multiple: true,
    defaultOption: true,
    type: filename => new FileDetails(filename)
  },
  { name: 'depth', type: Number }
]

const options = commandLineArgs(optionDefinitions)

console.log(options)

/*
Example output:

$ node example/type.js package.json nothing.js
{ file:
   [ FileDetails { filename: 'package.json', exists: true },
     FileDetails { filename: 'nothing.js', exists: false } ] }
*/