# @eeue56/baner

> Flag parsing library in Typescript

Latest version **1.1.0** (published 2026-02-01) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @eeue56/baner
pnpm add @eeue56/baner
yarn add @eeue56/baner
bun add @eeue56/baner
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2026-02-01 |
| First published | 2021-06-14 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 88.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | eeue56 |
| Maintainers | eeue56 |
| Keywords | typescript, hiraeth |

## Links

- npm: https://www.npmjs.com/package/@eeue56/baner
- Repository: https://github.com/eeue56/baner
- Homepage: https://github.com/eeue56/baner#readme
- Issues: https://github.com/eeue56/baner/issues
- npm.io page: https://npm.io/package/@eeue56/baner

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2026-02-01
- 0.0.4-3 (alpha) — 2026-01-31
- 1.0.0 — 2026-01-31
- 0.0.4-2 — 2026-01-31
- 0.0.4-1 — 2026-01-31
- 0.0.4-0 — 2026-01-31
- 0.0.3 — 2022-07-22
- 0.0.2 — 2021-10-11
- 0.0.1 — 2021-06-14

## README

# baner

Flag parsing library in Typescript

Part of the [Hiraeth](https://github.com/eeue56/hiraeth) collection.

# Installation

```bash
npm install --save @eeue56/baner
```

# Core functionality

The library is built on the ideas:

- A command line library might have multiple flags
- Every flag should have help text
- Arguments to the command line are either: strings, numbers, booleans, or lists of those
- Types are good, let's do more of that.

[API docs](docs/src/baner.md)

# Example

```typescript
const helloParser = parser(
    longFlag("name", "The name to say hi to", string()),
    longFlag("age", "The age of the person", number()),
    longFlag("pets", "Names of your pets", variableList(string())),
    longFlag("type", "Type of owner", oneOf(["human", "alien"])),
    longFlag("pet-type", "Type of pets", variableList(oneOf(["cat", "dog"]))),
    bothFlag("h", "help", "This help text", empty()),
);

function sayHi(
    name: string,
    age: number,
    pets: string[],
    type: "human" | "alien",
    petTypes: Exclude<
        ProgramValuesOf<typeof helloParser>["pet-type"],
        undefined
    >,
): void {
    console.log(`Hi, ${name}! Congrats on being ${age} years old.`);
    if (type === "alien") console.log("Welcome to earth!");

    if (pets.length > 0) {
        console.log(
            `Wow, you had ${pets.length} pets. I bet ${pets.join(
                ", ",
            )} were good pets to have`,
        );
    }

    for (const petType of petTypes) {
        console.log("And it was a....", petType);
    }
}

function showHelp(program: ProgramOf<typeof helloParser>): void {
    console.log("Provide a name via --name and age via --age");
    console.log(help(helloParser));
    console.log("Supported flags:", program.flags);
}

const program = parse(helloParser, process.argv);

if (program.flags["help"].isPresent) {
    showHelp(program);
} else {
    const errors = allErrors(program);
    const missing = allMissing(program, ["help"]);
    const values = allValues(program);

    if (errors.length > 0) {
        console.log("Errors:");
        console.log(errors.join("\n"));
    } else if (missing.length > 0) {
        console.log("Missing flags:");
        console.log(missing.join("\n"));
    } else {
        sayHi(
            values.name!,
            values.age!,
            values.pets!,
            values.type!,
            values["pet-type"]!,
        );
    }
}
```

# Name

Baner means "flag" in Welsh. In English, you'd pronounce it as "ban-eh-eruh".

---
_Source: https://npm.io/package/@eeue56/baner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
