custom-js-utils v1.1.4

custom-js-utils

This repository contains utils for creating Combeenation custom JS applications.

Typings

Besides TS typings for all available util methods provided by this repo, it also provides typings for "publicly" available Combeenation system code which is present in every configurator and can be consumed/used by custom JS code. All typings can be used by adding the following lines to the file typings/index.d.ts within the consuming custom JS projcet:

/// <reference types="custom-js-utils" />

This reference also includes typings for jQuery.

At the time of writing jQuery came in version 3.3.0 whilst we're actually using 3.1.0. There shouldn't be any major differences regarding to API of those 2 versions so we can ignore this.

What does this mean for the consumer? Take good care when using jQuery in your custom JS code and don't blindly trust auto completion & linting in the IDE here.

Scripts

• lint: executes linter to check for defined syntax rules
• build: installs dependencies and compiles the code into the dist folder
• doc: creates documentation via typedoc and places them into the docs folder
• deploy: compiles source and publishes package => set a new package version number before publishing, also don't forget to login at npm (npm login)
• link: compiles source, creates local packages and link it, package can be consumed by other local project (eg: custom-js) => https://www.deadcoderising.com/how-to-smoothly-develop-node-modules-locally-using-npm-link/
• unlink: removes link