kit-utils

A Script Kit environment (what is a Kenv?) with UI utilities and other scripting goodies.

Except for some demos, this repo does not contain any runnable scripts and is meant to be used as a TypeScript library you can reference in your own scripts.

Installation

[!TIP] This package can either be used as a kenv, or be installed via NPM.

Which should I choose?

• If you want to run the Demo apps 👉 Install as kenv
• If you expect to be making occasional changes to the utilities here 👉 Install as kenv
• If you plan on contributing 👉 Install as kenv
• Otherwise 👉 Install from NPM

Installing as a kenv

1. Direct link: https://scriptkit.com/api/kenv?repo=JosXa/kit-utils
2. Accept the risks and install
3. Import utils directly from the kenv, usually import {...} from '../kenvs/kit-utils'

Using as an NPM library

Simply paste
import {} from '@josxa/kit-utils'
into one of your scripts and wait for Kit to prompt you to install it.

Or install explicitly using npm install @josxa/kit-utils, you know the drill.

Demos

After installation as a kenv, run the "Show or Hide Demos" script to get a feel for what's possible.

API

Prompt Helpers

crudArg

A wrapper around arg that remembers previous user choices, with actions to create, read, update, and delete cached entries.

Example:

import { crudArg } from '@josxa/kit-utils'

const city = await crudArg('Enter a city name')

await div(`You selected: ${city}`)

refreshable

See Docstring

Example:

See Demo