1.2.0 • Published 1 year ago

cantor-dust-cli v1.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

cantor-dust-cli

Print the Cantor Dust Fractal to the console!

What cantor-dust-cli prints to the console

npm version bundle size downloads license

Why the console? Because it's the cool way.

See All Fractals in the fractals-cli project.

Usage

Via npx:

$ npx cantor-dust-cli <n>
$ npx cantor-dust-cli <n> [size] [options]

where n >= 0 and size >= n (if provided).

Via Global Install

$ npm install --global cantor-dust-cli
$ cantor-dust-cli <n>
$ cantor-dust-cli <n> [size] [options]

where n >= 0 and size >= n (if provided).

Via Import

$ npm install cantor-dust-cli

then:

const cantor = require('cantor-dust-cli');
console.log(cantor.create(<n>);
console.log(cantor.create(<n>, { 
    size: <number>, 
    character: <character> 
}));

The config params are optional.

Options

Recursive Step

$ cantor-dust-cli <n>

The first param <n> is the recursive step. <n> should be an integer greater than or equal to 0.

Examples:

$ cantor-dust-cli 2

What cantor-dust-cli prints to the console

$ cantor-dust-cli 3

What cantor-dust-cli prints to the console

Size

$ cantor-dust-cli <n> [size]

The optional [size] param allows the Cantor Dust fractal to be drawn at larger sizes. [size] should be an integer greater than or equal to <n>. Including size will draw a Cantor Dust fractal of <n> recursive steps the size of a Cantor Dust fractal with [size] recursive steps.

Example:

$ cantor-dust-cli 2 3

What cantor-dust-cli prints to the console

Custom Characters

$ cantor-dust-cli <n> --character=<character>

The optional --character=<character> param will draw sqaures using the provided character. (Please provide only 1 character)

Example:

$ cantor-dust-cli 2 3 --character=*

What cantor-dust-cli prints to the console

By default, squares are drawn using ANSI inverse codes: \u001b[7m. To instead draw using unicode block characters, add the --blocks param (or shorthand -b).

$ cantor-dust-cli <n> --blocks

(May look better/worse on certain terminals)

Related

Main Project

Fractal Shapes

Fractal Patterns

Space Filling Curves

License