Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dizmo/functions
dizmoFun: library of functions
https://github.com/dizmo/functions
dizmo functions javascript library typescript
Last synced: about 15 hours ago
JSON representation
dizmoFun: library of functions
- Host: GitHub
- URL: https://github.com/dizmo/functions
- Owner: dizmo
- License: isc
- Created: 2018-07-18T17:59:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-17T07:19:23.000Z (about 1 year ago)
- Last Synced: 2024-08-09T02:37:54.652Z (3 months ago)
- Topics: dizmo, functions, javascript, library, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@dizmo/functions
- Size: 3.62 MB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://npmjs.org/package/@dizmo/functions)
[](https://travis-ci.com/dizmo/functions)
[](https://coveralls.io/github/dizmo/functions?branch=master)
# @dizmo/functions
Library of useful functions, which can be used to develop dizmos.
## Usage
### Installation
```sh
npm install @dizmo/functions --save
```
### Require
```javascript
import '@dizmo/functions';
```
### Example(s)
```typescript
import { agent } from '@dizmo/functions'
```
```typescript
import { after, before } from '@dizmo/functions'
```
```typescript
import { buffered, queued } from '@dizmo/functions'
```
```typescript
import { experimental, unexperimental } from '@dizmo/functions';
```
```typescript
import { deprecated, undeprecated } from '@dizmo/functions';
```
```typescript
import { filter } from '@dizmo/functions'
```
```typescript
import { Lock } from '@dizmo/functions'
```
```typescript
import { partial } from '@dizmo/functions'
```
```typescript
import { random } from '@dizmo/functions'
```
```typescript
import { trace, traceable } from '@dizmo/functions'
```
```typescript
import { array2tree, object2tree } from '@dizmo/functions'
```
```typescript
import { tree2array, tree2object } from '@dizmo/functions'
```
## Development
### Clean
```sh
npm run clean
```
### Build
```sh
npm run build
```
#### without linting and cleaning:
```sh
npm run -- build --no-lint --no-clean
```
#### with UMD bundling (incl. minimization):
```sh
npm run -- build --prepack
```
#### with UMD bundling (excl. minimization):
```sh
npm run -- build --prepack --no-minify
```
### Lint
```sh
npm run lint
```
#### with auto-fixing:
```sh
npm run -- lint --fix
```
### Test
```sh
npm run test
```
#### without linting, cleaning and (re-)building:
```sh
npm run -- test --no-lint --no-clean --no-build
```
### Cover
```sh
npm run cover
```
#### without linting, cleaning and (re-)building:
```sh
npm run -- cover --no-lint --no-clean --no-build
```
## Debugging
Connect `@dizmo/functions` to another project:
```sh
[@dizmo/functions] $ npm link # symlink global:@dizmo/functions
```
```sh
[a-project] $ npm link @dizmo/functions # symlink node-modules:@dizmo/functions
```
```sh
[a-project] $ head webpack.config.js # ensure @dizmo/functions in entry.main
```
```
entry: {
main: [..., '@dizmo/functions', './source/index.js']
}
```
Disconnect `@dizmo/functions` from the project:
```sh
[a-project] $ npm unlink @dizmo/functions # delete local symlink
```
```sh
[@dizmo/functions] $ npm uninstall -g # delete global symlink
```
## Documentation
```sh
npm run docs
```
## Publication
```sh
npm publish
```
#### initially (if public):
```sh
npm publish --access=public
```
## Copyright
© 2021 [dizmo AG](https://dizmo.com/), Switzerland