https://github.com/ecomplus/utils

Isomorphic JS utility functions to E-Com Plus (not only) related apps
https://github.com/ecomplus/utils

e-commerce ecommerce-apps ecomplus ecomutils javascript-utils utility-functions

Last synced: about 2 months ago
JSON representation

Isomorphic JS utility functions to E-Com Plus (not only) related apps

• Host: GitHub
• URL: https://github.com/ecomplus/utils
• Owner: ecomplus
• License: mit
• Created: 2019-06-25T19:05:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-21T16:02:47.000Z (2 months ago)
• Last Synced: 2024-10-22T03:53:21.742Z (2 months ago)
• Topics: e-commerce, ecommerce-apps, ecomplus, ecomutils, javascript-utils, utility-functions
• Language: JavaScript
• Homepage: https://developers.e-com.plus/utils/
• Size: 3.6 MB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# E-Com Plus Utils

[![Publish](https://github.com/ecomplus/utils/workflows/Publish/badge.svg)](https://github.com/ecomplus/utils/actions?workflow=Publish) [![CodeFactor](https://www.codefactor.io/repository/github/ecomplus/utils/badge)](https://www.codefactor.io/repository/github/ecomplus/utils) [![npm version](https://img.shields.io/npm/v/@ecomplus/utils.svg)](https://www.npmjs.org/@ecomplus/utils) [![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

JS utility functions to E-Com Plus (not only) related apps

[CHANGELOG](https://github.com/ecomplus/utils/blob/master/CHANGELOG.md)

## Usage

The `@ecomplus/utils` package provides a [list of methods](https://developers.e-com.plus/utils/ecomUtils.html),

each one is a utility function related to e-commerce apps and E-Com Plus APIs and schemas.

It's available for both Node.js and browser environments, and can also be imported entirely or partially with ES modules.

- [Get started](https://developers.e-com.plus/utils/module-@ecomplus_utils.html)

- [Methods](https://developers.e-com.plus/utils/ecomUtils.html)

```js

import {

  i18n,

  formatMoney,

  minQuantity,

  price,

  // ...

} from '@ecomplus/utils'

i18n({ en_us: 'Hello', pt_br: 'Olá' })

// => 'Hello'

formatMoney(10)

// => $10.00

```

## Development

Fork/clone this repository and install dependencies normally:

```bash

git clone https://github.com/ecomplus/utils

cd utils

npm i

```

Then you can edit source files and test locally with `npm run serve`.

### Contributing

Please read the [contribution guidelines](CONTRIBUTING.md).

### Deploy

Take a look on `package.json` scripts:

- `npm run doc` - Update jsdoc/docdash generated documentation;

- `npm run release` - Generate changelog and new version;