julia-set-node v0.2.0

julia-set-node

Rendering Julia sets for complex functions on the server side.

This package allows rendering Julia / Fatou sets for complex functions in Node. The resulting images often have fractal-like nature.

API

An image can be rendered using the default export of the package:

declare function render(
  options: Options & { screenshot: ScreenshotOptions },
): Promise<void | string | Uint8Array>;

export default render;

Here, Options is the rendering options from the julia-set package, and ScreenshotOptions are defined as:

declare interface ScreenshotOptions {
  width: number,
  height: number,
  browser?: Browser,
  quality?: number,
  path?: string,
  type?: 'png' | 'jpeg',
  encoding?: 'binary' | 'base64',
}

• width and height are sizes of the generated image
• The remaining options correspond to puppeteer screenshot options. For example, type determines the image type, quality the JPEG quality parameter, etc.
• If specified, browser determines the pupetteer browser instance used to render the image. This may be useful to save resources during batch rendering.

Depending on specified ScreenshotOptions, the Promise returned by render may resolve to nothing (if path to save the image was specified), or to a Uint8Array / string with image data (in the binary and base64 encodings, respectively).

License

julia-set-node is licensed under the Apache 2.0 license.