Skip to content

nutriot/morphagene-options

Repository files navigation

@nutriot/morphagene-options

Helper for editing Morphagene options.txt files

License Version: npm Version: jsr Build: NodeJS Build: Deno

Installation 💿

npm install --save @nutriot/morphagene-options

Usage 🚀

// all environments
import { parse, stringify, type MorphageneOptions } from '@nutriot/morphagene-options'

// NodeJS only
import { parseFile } from '@nutriot/morphagene-options/fs'

// Bonus: schemas for Valibot and Zod
import { valibotSchema, zodSchema } from '@nutriot/morphagene-options'

API ⚙️

parse

Usage: parse(optionsString, strict = true)

Parses an options string into a JavaScript object.

stringify

Usage: stringify(optionsObject, strict = true)

Stringifies a JavaScript object into an options string

parseFile

Caution

The following methods do not work in the browser

Parses an options.txt file into a JavaScript object.

Usage:

parseFile.sync('options.txt', strict = true)
await parseFile.async('options.txt', strict = true)

License ©️

This work is licensed under The MIT License.

Packages

No packages published