Giter VIP home page Giter VIP logo

js-utils-1's Introduction

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).

js-utils-1's People

Contributors

jshakes avatar chriszarate avatar hallee avatar itsjustbrian avatar lint-action avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.