fluent-skeleton
Version:
560 lines (160 loc) • 4.67 kB
Markdown
#
### packages/skeleton/disted/cli.js
#### docs(pattern)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| pattern | `Array.<string>` | array of glob patterns | |
##### Returns
- `CLI` @chainable
#### handle()
##### Returns
- `AppCli` @chainable
### packages/skeleton/disted/ObjChain.js
#### module.exports()
##### Returns
- `Void`
#### dynamic(data)
dynamically adds properties when called if they do not exist
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| data | `string` `Object` | json data | |
##### Returns
- `JSONChain`
#### init(data)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| data | `string` `Object` | json data | |
##### Returns
- `JSONChain`
#### extend(methods[, nest=false])
take strings, make them methods to .set on
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| methods | `Array.<string>` | | |
| nest=false | `boolean` | nest the .set | *Optional* |
##### Returns
- `JSONChain`
#### has(key)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| key | `any` | | |
##### Returns
- `Boolean`
#### del(key)
delete. remove
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| key | `any` | | |
##### Returns
- `ObjChain`
#### val([key=null])
get a value
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| key=null | `any` | | *Optional* |
##### Returns
- `any` current key or named if there is key param
#### use(obj)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| obj | `Object` | | |
##### Returns
- `ObjChain`
### packages/skeleton/disted/VFS.js
#### constructor(parent)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| parent | `ChainedMap` | | |
##### Returns
- `Void`
#### file(name[, folder=null])
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| name | `string` | | |
| folder=null | `string` | | *Optional* |
##### Returns
- `VFS` @chainable
#### folder(name[, folder=null])
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| name | `string` | | |
| folder=null | `string` | nested folder | *Optional* |
##### Returns
- `VFS` @chainable
#### filter(cb)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| cb | `Function` | | |
##### Returns
- `VFS` @chainable
#### create([force=false])
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| force=false | `boolean` | create even if it exists | *Optional* |
##### Returns
- `Folder` @chainable
#### del()
##### Returns
- `Folder` @chainable
#### chwd(cwd)
cd(): VFS {}
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| cwd | `string` | | |
##### Returns
- `VFS` @chainable
#### cwd()
##### Returns
- `string`
#### toString()
##### Returns
- `string`
#### toConfig()
##### Returns
- `[object Object]`
### packages/skeleton/disted/VFSFolder.js
#### constructor(parent)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| parent | `ChainedMap` | | |
##### Returns
- `Void`
#### file(file)
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| file | `File` | for this folder | |
##### Returns
- `Folder` @chainable
#### del()
##### Returns
- `Folder` @chainable
#### create([force=false])
##### Parameters
| Name | Type | Description | |
| ---- | ---- | ----------- | -------- |
| force=false | `boolean` | create even if it exists | *Optional* |
##### Returns
- `Folder` @chainable
#### toConfig()
##### Returns
- `Object` entries
#### toString()
##### Returns
- `string`
*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*