Installation

Using npm:

npm install @usssa/core-client

Using yarn:

yarn add @usssa/core-client

Usage

Import the functions you need from the package.

import { compareObjects } from '@usssa/core-client'

const diff = compareObjects({ a: 1, b: 2, c: 3 }, { a: 1, b: 2, c: 4 })
console.log(diff)

Functions

compareObjects

Compares two objects and returns their differences, excluding specified properties

const diff = compareObjects({ a: 1, b: 2, c: 3 }, { a: 1, b: 2, c: 4 })
console.log(diff)

Local Development

Perform code changes in the src directory. Make sure there are corresponding tests in the __tests__ directory.

To verify your changes make sure to run a build and run the tests.

npm run build
npm run test:ci

Once verified, commit your changes. Then run npm version <patch|minor|major> to update the package version. This will also push the changes to the remote repository and create a new git tag.

In GitHub, find the new tag and publish it as a release. This will trigger GitHub Actions to build the package and publish it to NPM.