Helpers

flag.mjs

@mr_ozio/scraper-utils · v2.5.0 · Generated April 21, 2026

Source: helpers/flag.mjs

Target Style

Target Style

2 exports

const

readFlag

Target Style 
export const readFlag = ({ named }) => {

Reads a CLI flag using named arguments.

Target style API. Preferred for new code.

Parameters

  • options{ named: string }

Returns

string | boolean

Example

const proxy = readFlag({
  named: '--proxy',
})

const

hasFlag

Target Style 
export const hasFlag = (name) => readFlag({ named: name }) !== false

Checks whether a CLI flag is present.

Target style API. Preferred for new code.

Parameters

  • namestring

Returns

boolean

Legacy Style

Legacy Style

1 exports

const

flag

Legacy Style 
export const flag = (name) => readFlag({ named: name })

Reads a CLI flag from process.argv.

Returns:

  • false when the flag is missing
  • true when the flag exists without a value
  • the string value when the flag looks like --name=value

Legacy API. Kept for older code and not the preferred choice for new code.

Parameters

  • namestring

Returns

string | boolean