hotscript

If you are using GitHub Pages for hosting, you can build the website and push it to the gh-pages branch by providing your GitHub username via the GIT_USER environment variable.

$ GIT_USER=<Your GitHub username> yarn deploy

Generate the static content for the website. The output will be placed in the build directory and can be hosted using any static content hosting service.

$ yarn build

To deploy the website using SSH, set the USE_SSH environment variable to true when running the deploy command.

$ USE_SSH=true yarn deploy

Start a local development server to preview the website. This command opens a browser window and supports live reloading, meaning most changes are reflected immediately without a server restart.

$ yarn start

To use the functions provided by hotscript, you can import them using either the Functions or the F alias.

import { Functions } from "hotscript";
// or
import { F } from "hotscript";

To use the Numbers utility in your project, import it from the hotscript package. You can use the full name Numbers or the shorthand N.

import { Numbers } from "hotscript";
// or
import { N } from "hotscript";

To use string manipulation utilities, you can import the Strings class or the shorthand S from the hotscript package.

import { Strings } from "hotscript";
// or
import { S } from "hotscript";

To use the Unions utility, you can import it using either its full name or the shorthand U from the hotscript package.

import { Unions } from "hotscript";
// or
import { U } from "hotscript";

To use the Tuples utility, import it from the hotscript package. You can import it using the named export Tuples or the shorthand T.

import { Tuples } from "hotscript";
// or
import { T } from "hotscript";

To use the Objects utility in your project, import it from the hotscript package. You can import it using its full name Objects or its shorthand alias O.

import { Objects } from "hotscript";
// or
import { O } from "hotscript";

You can import the Booleans type or its shorthand alias B from the hotscript package to work with boolean logic in your type transformations.

import { Booleans } from "hotscript";
// or
import { B } from "hotscript";