Skip to content

Commit

Permalink
feat: add utils from isolex
Browse files Browse the repository at this point in the history
  • Loading branch information
ssube committed Mar 29, 2020
1 parent 3b193a1 commit e227fa6
Show file tree
Hide file tree
Showing 108 changed files with 2,491 additions and 132 deletions.
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Expand Up @@ -150,7 +150,7 @@ sonar-success:
script:
- make node_modules
- sonar-scanner
-Dsonar.projectKey=ssube_rollup-template
-Dsonar.projectKey=ssube_js-utils
-Dsonar.projectVersion=${CI_COMMIT_REF_SLUG}
-Dsonar.organization=ssube-github
-Dsonar.sources=src/,test/
Expand Down
1 change: 0 additions & 1 deletion config/eslint.json
Expand Up @@ -154,7 +154,6 @@
"error",
"any",
"Number",
"String",
"Boolean",
"Undefined"
],
Expand Down
6 changes: 6 additions & 0 deletions config/rollup-named.json
Expand Up @@ -2,5 +2,11 @@
"node_modules/chai/index.js": [
"expect",
"use"
],
"node_modules/lodash/lodash.js": [
"isFunction",
"isMap",
"isObject",
"isString"
]
}
2 changes: 1 addition & 1 deletion docs/api/index.md
Expand Up @@ -8,5 +8,5 @@

| Package | Description |
| --- | --- |
| [@apextoaster/rollup-template](./rollup-template.md) | |
| [@apextoaster/js-utils](./js-utils.md) | |

20 changes: 20 additions & 0 deletions docs/api/js-utils.arraymapper._constructor_.md
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ArrayMapper](./js-utils.arraymapper.md) &gt; [(constructor)](./js-utils.arraymapper._constructor_.md)

## ArrayMapper.(constructor)

Constructs a new instance of the `ArrayMapper` class

<b>Signature:</b>

```typescript
constructor(options: ArrayMapperOptions);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>ArrayMapperOptions</code> | |

22 changes: 22 additions & 0 deletions docs/api/js-utils.arraymapper.map.md
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ArrayMapper](./js-utils.arraymapper.md) &gt; [map](./js-utils.arraymapper.map.md)

## ArrayMapper.map() method

<b>Signature:</b>

```typescript
map(input: Array<string>): Map<string, Array<string>>;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| input | <code>Array&lt;string&gt;</code> | |

<b>Returns:</b>

`Map<string, Array<string>>`

32 changes: 32 additions & 0 deletions docs/api/js-utils.arraymapper.md
@@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ArrayMapper](./js-utils.arraymapper.md)

## ArrayMapper class

<b>Signature:</b>

```typescript
export declare class ArrayMapper
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(options)](./js-utils.arraymapper._constructor_.md) | | Constructs a new instance of the <code>ArrayMapper</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [rest](./js-utils.arraymapper.rest.md) | | <code>string</code> | |
| [skip](./js-utils.arraymapper.skip.md) | | <code>number</code> | |
| [take](./js-utils.arraymapper.take.md) | | <code>Array&lt;string&gt;</code> | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [map(input)](./js-utils.arraymapper.map.md) | | |

11 changes: 11 additions & 0 deletions docs/api/js-utils.arraymapper.rest.md
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ArrayMapper](./js-utils.arraymapper.md) &gt; [rest](./js-utils.arraymapper.rest.md)

## ArrayMapper.rest property

<b>Signature:</b>

```typescript
readonly rest: string;
```
11 changes: 11 additions & 0 deletions docs/api/js-utils.arraymapper.skip.md
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ArrayMapper](./js-utils.arraymapper.md) &gt; [skip](./js-utils.arraymapper.skip.md)

## ArrayMapper.skip property

<b>Signature:</b>

```typescript
readonly skip: number;
```
11 changes: 11 additions & 0 deletions docs/api/js-utils.arraymapper.take.md
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ArrayMapper](./js-utils.arraymapper.md) &gt; [take](./js-utils.arraymapper.take.md)

## ArrayMapper.take property

<b>Signature:</b>

```typescript
readonly take: Array<string>;
```
13 changes: 13 additions & 0 deletions docs/api/js-utils.asynctracker._constructor_.md
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [(constructor)](./js-utils.asynctracker._constructor_.md)

## AsyncTracker.(constructor)

Constructs a new instance of the `AsyncTracker` class

<b>Signature:</b>

```typescript
constructor();
```
15 changes: 15 additions & 0 deletions docs/api/js-utils.asynctracker.clear.md
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [clear](./js-utils.asynctracker.clear.md)

## AsyncTracker.clear() method

<b>Signature:</b>

```typescript
clear(): void;
```
<b>Returns:</b>

`void`

15 changes: 15 additions & 0 deletions docs/api/js-utils.asynctracker.disable.md
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [disable](./js-utils.asynctracker.disable.md)

## AsyncTracker.disable() method

<b>Signature:</b>

```typescript
disable(): void;
```
<b>Returns:</b>

`void`

15 changes: 15 additions & 0 deletions docs/api/js-utils.asynctracker.dump.md
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [dump](./js-utils.asynctracker.dump.md)

## AsyncTracker.dump() method

<b>Signature:</b>

```typescript
dump(): void;
```
<b>Returns:</b>

`void`

15 changes: 15 additions & 0 deletions docs/api/js-utils.asynctracker.enable.md
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [enable](./js-utils.asynctracker.enable.md)

## AsyncTracker.enable() method

<b>Signature:</b>

```typescript
enable(): void;
```
<b>Returns:</b>

`void`

15 changes: 15 additions & 0 deletions docs/api/js-utils.asynctracker.getstack.md
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [getStack](./js-utils.asynctracker.getstack.md)

## AsyncTracker.getStack() method

<b>Signature:</b>

```typescript
static getStack(): string;
```
<b>Returns:</b>

`string`

38 changes: 38 additions & 0 deletions docs/api/js-utils.asynctracker.md
@@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md)

## AsyncTracker class

Async resource tracker using node's internal hooks.

This probably won't work in a browser. It does not hold references to the resource, to avoid leaks. Adapted from https://gist.github.com/boneskull/7fe75b63d613fa940db7ec990a5f5843\#file-async-dump-js

<b>Signature:</b>

```typescript
export declare class AsyncTracker
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)()](./js-utils.asynctracker._constructor_.md) | | Constructs a new instance of the <code>AsyncTracker</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [size](./js-utils.asynctracker.size.md) | | <code>number</code> | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [clear()](./js-utils.asynctracker.clear.md) | | |
| [disable()](./js-utils.asynctracker.disable.md) | | |
| [dump()](./js-utils.asynctracker.dump.md) | | |
| [enable()](./js-utils.asynctracker.enable.md) | | |
| [getStack()](./js-utils.asynctracker.getstack.md) | <code>static</code> | |

11 changes: 11 additions & 0 deletions docs/api/js-utils.asynctracker.size.md
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [AsyncTracker](./js-utils.asynctracker.md) &gt; [size](./js-utils.asynctracker.size.md)

## AsyncTracker.size property

<b>Signature:</b>

```typescript
get size(): number;
```
21 changes: 21 additions & 0 deletions docs/api/js-utils.childprocesserror._constructor_.md
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ChildProcessError](./js-utils.childprocesserror.md) &gt; [(constructor)](./js-utils.childprocesserror._constructor_.md)

## ChildProcessError.(constructor)

Constructs a new instance of the `ChildProcessError` class

<b>Signature:</b>

```typescript
constructor(msg?: string, ...nested: Array<Error>);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| msg | <code>string</code> | |
| nested | <code>Array&lt;Error&gt;</code> | |

18 changes: 18 additions & 0 deletions docs/api/js-utils.childprocesserror.md
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [ChildProcessError](./js-utils.childprocesserror.md)

## ChildProcessError class

<b>Signature:</b>

```typescript
export declare class ChildProcessError extends BaseError
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(msg, nested)](./js-utils.childprocesserror._constructor_.md) | | Constructs a new instance of the <code>ChildProcessError</code> class |
22 changes: 22 additions & 0 deletions docs/api/js-utils.concat.md
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [concat](./js-utils.concat.md)

## concat() function

<b>Signature:</b>

```typescript
export declare function concat(chunks: Array<Buffer>): Buffer;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| chunks | <code>Array&lt;Buffer&gt;</code> | |

<b>Returns:</b>

`Buffer`

26 changes: 26 additions & 0 deletions docs/api/js-utils.countof.md
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-utils](./js-utils.md) &gt; [countOf](./js-utils.countof.md)

## countOf() function

Calculate the "length" of an array or value.

Arrays return their length, single values return 1, and nil values return 0. This counts the number of elements that setOrPush would add.

<b>Signature:</b>

```typescript
export declare function countOf(val: unknown): number;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| val | <code>unknown</code> | |

<b>Returns:</b>

`number`

0 comments on commit e227fa6

Please sign in to comment.