Skip to main content
Module

std/flags/mod.ts>parse

Deno standard library
Go to Latest
function parse
import { parse } from "https://deno.land/std@0.139.0/flags/mod.ts";

Take a set of command line arguments, optionally with a set of options, and return an object representing the flags found in the passed arguments.

By default any arguments starting with - or -- are considered boolean flags. If the argument name is followed by an equal sign (=) it is considered a key-value pair. Any arguments which could not be parsed are available in the _ property of the returned object.

import { parse } from "./mod.ts";
const parsedArgs = parse(Deno.args);
import { parse } from "./mod.ts";
const parsedArgs = parse(["--foo", "--bar=baz", "--no-qux", "./quux.txt"]);
// parsedArgs: { foo: true, bar: "baz", qux: false, _: ["./quux.txt"] }

Parameters

args: string[]
optional
unnamed 1: ParseOptions = [UNSUPPORTED]