Skip to content

A collection of reusable JavaScript utilities for Quartz products.

Notifications You must be signed in to change notification settings

Quartz/js-utils

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6578b91 · Jul 20, 2022

History

88 Commits
Oct 15, 2020
Jul 20, 2022
Oct 14, 2020
Jul 20, 2022
Oct 20, 2020
Jul 20, 2022
Jul 20, 2022
Oct 21, 2020
Oct 22, 2020

Repository files navigation

Quartz JavaScript utilities

npm version

A collection of reusable JavaScript utilities for Quartz products, with optional TypeScript support.

All functions are written in TypeScript and transpiled into ES2017 JavaScript (with type definitions).

Installation

npm i @quartz/js-utils

Usage

Import functions from the js-utils package, e.g.

import { arrayFromRange, resizeWPImage } from '@quartz/js-utils'

TypeScript hints are available if the file into which the functions are imported is a .ts or .tsx file.

Contributing

Functions must be written in TypeScript whenever possible.

Export one function per file with a test suite (.test.js).

Before opening a pull request

  • Export any new functions to src/index.ts
  • Add a test suite for any new functions
  • Ensure tests pass (npm t)
  • Increment the package.json version using npm version

Deploying

Use npm publish to publish the package to npm. TypeScript will be built on publish (via npm run build).

About

A collection of reusable JavaScript utilities for Quartz products.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published