Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
29 changed files
with
515 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ArrayMapperOptions](./js-utils.arraymapperoptions.md) | ||
|
||
## ArrayMapperOptions interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ArrayMapperOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [rest](./js-utils.arraymapperoptions.rest.md) | <code>string</code> | | | ||
| [skip](./js-utils.arraymapperoptions.skip.md) | <code>number</code> | | | ||
| [take](./js-utils.arraymapperoptions.take.md) | <code>Array<string></code> | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ArrayMapperOptions](./js-utils.arraymapperoptions.md) > [rest](./js-utils.arraymapperoptions.rest.md) | ||
|
||
## ArrayMapperOptions.rest property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
rest: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ArrayMapperOptions](./js-utils.arraymapperoptions.md) > [skip](./js-utils.arraymapperoptions.skip.md) | ||
|
||
## ArrayMapperOptions.skip property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
skip: number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ArrayMapperOptions](./js-utils.arraymapperoptions.md) > [take](./js-utils.arraymapperoptions.take.md) | ||
|
||
## ArrayMapperOptions.take property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
take: Array<string>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildOptions](./js-utils.childoptions.md) > [args](./js-utils.childoptions.args.md) | ||
|
||
## ChildOptions.args property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
args: Array<string>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildOptions](./js-utils.childoptions.md) > [command](./js-utils.childoptions.command.md) | ||
|
||
## ChildOptions.command property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
command: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildOptions](./js-utils.childoptions.md) > [cwd](./js-utils.childoptions.cwd.md) | ||
|
||
## ChildOptions.cwd property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
cwd: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildOptions](./js-utils.childoptions.md) > [env](./js-utils.childoptions.env.md) | ||
|
||
## ChildOptions.env property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
env: Array<NameValuePair<string>>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildOptions](./js-utils.childoptions.md) | ||
|
||
## ChildOptions interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ChildOptions | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [args](./js-utils.childoptions.args.md) | <code>Array<string></code> | | | ||
| [command](./js-utils.childoptions.command.md) | <code>string</code> | | | ||
| [cwd](./js-utils.childoptions.cwd.md) | <code>string</code> | | | ||
| [env](./js-utils.childoptions.env.md) | <code>Array<NameValuePair<string>></code> | | | ||
| [timeout](./js-utils.childoptions.timeout.md) | <code>number</code> | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildOptions](./js-utils.childoptions.md) > [timeout](./js-utils.childoptions.timeout.md) | ||
|
||
## ChildOptions.timeout property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
timeout: number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildResult](./js-utils.childresult.md) | ||
|
||
## ChildResult interface | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ChildResult | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [status](./js-utils.childresult.status.md) | <code>number</code> | | | ||
| [stderr](./js-utils.childresult.stderr.md) | <code>string</code> | | | ||
| [stdout](./js-utils.childresult.stdout.md) | <code>string</code> | | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildResult](./js-utils.childresult.md) > [status](./js-utils.childresult.status.md) | ||
|
||
## ChildResult.status property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
status: number; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildResult](./js-utils.childresult.md) > [stderr](./js-utils.childresult.stderr.md) | ||
|
||
## ChildResult.stderr property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
stderr: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildResult](./js-utils.childresult.md) > [stdout](./js-utils.childresult.stdout.md) | ||
|
||
## ChildResult.stdout property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
stdout: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [ChildSpawner](./js-utils.childspawner.md) | ||
|
||
## ChildSpawner type | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type ChildSpawner = typeof spawn; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [constructorName](./js-utils.constructorname.md) | ||
|
||
## constructorName() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function constructorName(val: object): string; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| val | <code>object</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`string` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [getConstructor](./js-utils.getconstructor.md) | ||
|
||
## getConstructor() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function getConstructor(val: object): Function; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| val | <code>object</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`Function` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [getHead](./js-utils.gethead.md) | ||
|
||
## getHead() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function getHead<TKey, TVal>(map: Map<TKey, Array<TVal>>, key: TKey): TVal; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| map | <code>Map<TKey, Array<TVal>></code> | | | ||
| key | <code>TKey</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`TVal` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [getHeadOrDefault](./js-utils.getheadordefault.md) | ||
|
||
## getHeadOrDefault() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function getHeadOrDefault<TKey, TVal>(map: Map<TKey, Array<Optional<TVal>>>, key: TKey, defaultValue: TVal): TVal; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| map | <code>Map<TKey, Array<Optional<TVal>>></code> | | | ||
| key | <code>TKey</code> | | | ||
| defaultValue | <code>TVal</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`TVal` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [getMethods](./js-utils.getmethods.md) | ||
|
||
## getMethods() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function getMethods<TValue extends object>(value: TValue): Set<Function>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| value | <code>TValue</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`Set<Function>` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [getOrDefault](./js-utils.getordefault.md) | ||
|
||
## getOrDefault() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function getOrDefault<TKey, TVal>(map: Map<TKey, TVal>, key: TKey, defaultValue: TVal): TVal; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| map | <code>Map<TKey, TVal></code> | | | ||
| key | <code>TKey</code> | | | ||
| defaultValue | <code>TVal</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`TVal` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@apextoaster/js-utils](./js-utils.md) > [leftPad](./js-utils.leftpad.md) | ||
|
||
## leftPad() function | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare function leftPad(val: string, min?: number, fill?: string): string; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| val | <code>string</code> | | | ||
| min | <code>number</code> | | | ||
| fill | <code>string</code> | | | ||
|
||
<b>Returns:</b> | ||
|
||
`string` | ||
|
Oops, something went wrong.