https://github.com/steamerjs/steamer-browserutils

browser utils
https://github.com/steamerjs/steamer-browserutils

Last synced: about 1 month ago
JSON representation

browser utils

• Host: GitHub
• URL: https://github.com/steamerjs/steamer-browserutils
• Owner: steamerjs
• Created: 2016-07-30T13:36:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-11T14:43:24.000Z (over 6 years ago)
• Last Synced: 2024-04-24T12:02:31.730Z (8 months ago)
• Language: JavaScript
• Size: 228 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## steamer-browserutils

Browser utils for development

[![NPM Version](https://img.shields.io/npm/v/steamer-browserutils.svg?style=flat)](https://www.npmjs.com/package/steamer-browserutils)

[![Travis](https://img.shields.io/travis/steamerjs/steamer-browserutils.svg)](https://travis-ci.org/steamerjs/steamer-browserutils)

[![Deps](https://david-dm.org/steamerjs/steamer-browserutils.svg)](https://david-dm.org/steamerjs/steamer-browserutils)

[![Coverage](https://img.shields.io/coveralls/steamerjs/steamer-browserutils.svg)](https://coveralls.io/github/steamerjs/steamer-browserutils)

### Functions

For usage details, you can checkout `./src/libs/`

####

* class

	- extend

* common

	- _stringify

	- _parse

* cookie

	- setCookie

	- delCookie

	- getCookie

* date

	- formatDate

* localstorage

	- setItem

	- delItem

	- getItem

* native

	- callApi

* safe

	- encodeHTML

	- decodeHTML

* type

	- isType

	- isBoolean

	- isNumber

	- isString

	- isFunction

	- isArray

	- isDate

	- isRegExp

	- isObject

	- isError

* url

	- getHash

 	- getQuery

 	- getUrlParam

### Usage

You can require the file like this:

```

// Node

let utils = require('steamer-browserutils');

// or

let utils = require('steamer-browserutils/dist/index.cjs.js); 

// ES6

import { extend, isType } from 'steamer-browserutils/dist/index.esm.js';

// umd

// you can use index.umd.js

```

By default, we require `steamer-browserutils/index.js` which is an `es5` version. However, sometimes you may need `es6` version for tree-shaking in `webpack` or `rollup`, then you can explicitly require `steamer-browserutils/index.esm.js`.

You also need to notice that compling tool like `webpack` may exclude `node_modules` when compling js files in order to speed up the whole compling process. If so, please remove this config or just put `./dist/index.esm.js` in your `src` folder.

```

{ 

    test: /\.js?$/,

    loader: 'babel',

    query: {

        // cacheDirectory: './webpack_cache/',

        plugins: ['transform-decorators-legacy'],

        presets: [

            'es2015-loose', 

            'react',

        ]

    },

    exclude: /node_modules/,

},

```

### Customized library

If you hope to customized certain types of APIs. For example, if you hope to exclude `safe` and `native` APIs, you can modify `./src/mains`.js by commenting `safe` and `natve` `export`.

```

// export {

//     callApi,

// } from './libs/native';

// export {

//     encodeHTML,

//     decodeHTML

// } from './libs/safe';

```

Please be cautious if you want to exlucde `common` since other APIs use its functions.

### Test

```javascript

npm test

```

### Changelog

* v0.5.0 finish basic features and add es6 and es5 support

* v1.0.0 add test

* v1.0.1 compatible with global

* v2.0.0 use rollup to bundle