# wizzi-browser

> Wizzi standalone for browser.

Latest version **0.6.10** (published 2019-03-01) · 0 weekly downloads

## Install

```sh
npm install wizzi-browser
pnpm add wizzi-browser
yarn add wizzi-browser
bun add wizzi-browser
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.10 |
| Published | 2019-03-01 |
| First published | 2019-02-28 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.28 |
| Dependencies | 13 |
| Unpacked size | 514.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stefano Bassoli |
| Maintainers | wizziteam |

## Links

- npm: https://www.npmjs.com/package/wizzi-browser
- Repository: https://github.com/wizzifactory/wizzi/tree/master/packages/wizzi-browser
- npm.io page: https://npm.io/package/wizzi-browser

## Dependencies (13)

- [i](https://npm.io/package/i.md) ^0.3.5
- [glob](https://npm.io/package/glob.md) ^7.1.2
- [async](https://npm.io/package/async.md) ^2.1.5
- [chalk](https://npm.io/package/chalk.md) ^1.1.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [hashids](https://npm.io/package/hashids.md) latest
- [promise](https://npm.io/package/promise.md) ^7.1.1
- [browserfs](https://npm.io/package/browserfs.md) latest
- [extsprintf](https://npm.io/package/extsprintf.md) ^1.2.0
- [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.4.15
- [randomstring](https://npm.io/package/randomstring.md) latest
- [isomorphic-git](https://npm.io/package/isomorphic-git.md) latest
- [json-stringify-safe](https://npm.io/package/json-stringify-safe.md) ^5.0.1

## Recent versions

- 0.6.10 (latest) — 2019-03-01
- 0.6.7 — 2019-02-28

## README

# wizzi-browser - ver 0.6 - kernel package

Wizzi standalone for browser.

## Work still in progress

Availability of features will be announced
on [Twitter](https://twitter.com/wizziteam) and [Facebook](https://www.facebook.com/wizzifactory)

## vfile - virtual file system
#### var vfile = require('wizzi-utils').vfile
### vfileInst - create a virtual file system instance
#### var vfileInst = vfile([fsimpl])
* `fsimpl` `Object` Default: NodeJS fs object or fs-graceful if available. 
### vfileInst.read(path_string, options[, callback])
* `path_string` 
* `options` `Object` 
* `callback` `Function` If absent the call is sync. * `err` 
* `content` 

### vfileInst.write(path_string, content, options[, callback])
* `path_string` 
* `content` `String` 
* `options` `Object` 
* `callback` `Function` If absent the call is sync. When the call is sync if `fsimpl` does not implement `readFileSync` throw Error.
* `err` 
* `content` 

### vfileInst.readJSON(path_string, options[, callback])
### vfileInst.writeJSON(path_string, obj, options[, callback])
## The `fsimpl` - interface

<p>This interface must be implemented by file system objects
`that expose their documents to the wizzi factory.`
</p>


<p>The `Sync` methods are optional, but a `Sync` call to an
`fsimpl that does not implement it throw an Error.`
</p>

#### stat(path, callback)

<p>The returned `stats` object must implement: stats.isFile()
`stats.isDirectory()`
</p>

#### statSync(path)

<p>The returned `stats` object must implement: stats.isFile()
`stats.isDirectory()`
</p>

#### lstat(path, callback)

<p>The returned `stats` object must implement: stats.isFile()
`stats.isDirectory()`
</p>

#### lstatSync(path)

<p>The returned `stats` object must implement: stats.isFile()
`stats.isDirectory()`
</p>

#### readFile(path[, options], callback)
#### readFileSync(path[, options])
#### writeFile(path, content[, options], callback)
#### writeFileSync(path, content[, options])
#### readdir(path[, options], callback)
#### readdirSync(path[, options])
#### mkdir(path[, options], callback)
#### mkdirSync(path[, options])
## verify - helper object
#### var verify = require('wizzi-utils').verify
## verify - type checks
#### verify.isDefined(item)
#### verify.isNullOrUndefined(item)
#### verify.isObject(item)
#### verify.isArray(item)
#### verify.isFunction(item)
#### verify.isNumber(item)
#### verify.isBoolean(item)
#### verify.isDate(item)
#### verify.isString(item)
#### verify.isEmpty(item)
#### verify.isNotEmpty(item)
#### verify.isPrimitive(item)
#### verify.isRegExp(item)
#### verify.isError(item)
#### verify.isAbsolutePath(item)
#### verify.isIttfMacro(item)
## verify.convert(value, type[, unquote])
* `value` `String` If `@@null` return null; if `@@undefined` return undefined. 
* `type` `String` One-of string, integer, float, boolean, date 
* `options` `Object` 
## verify.canConvertTo(value, type)
* `value` `String` 
* `type` `String` One-of string, integer, float, boolean, date 
## verify - validations
#### verify.isEmail(value)
#### verify.isEmails(value)
#### verify.isMinLength(value, length)
#### verify.isMaxLength(value, length)
#### verify.isExactLength(value, length)
#### verify.isGreaterThan(value, test)
#### verify.isLessThan(value, test)
#### verify.isGreaterEqualThan(value, test)
#### verify.isLessEqualThan(value, test)
#### verify.isAlpha(value)
#### verify.isAlphaNumeric(value)
#### verify.isIp(value)
#### verify.isBase64(value)
#### verify.isUrl(value)
#### verify.isCreditCard(value)
#### verify.isGreaterThanDate(value, date)
#### verify.isLessThanDate(value, date)
#### verify.isGreaterEqualDate(value, date)
#### verify.isLessEqualDate(value, date)
## verify - errors
#### verify.error([inner,] [obj,] message, [arg-1[, arg-2[, arg-...]]])
#### verify.fatal(err[, code])
## folderScanner - ittf documents folder scanner
#### var folderScanner = require('wizzi-utils').folderScanner
## folderScanner.scan(folderPath[, options])
* `folderPath` `uri` 
* `options` `Object` 
* returns the root IttfFsNode of the 'folderPath' with its descendant folders as children. 
## ittfMTreeEx - enhanced mTree with import, export, analize capabilities
#### var ittfMTreeEx = require('wizzi-utils').ittfMTreeEx
#### ittfMTreeEx.loadFrom(path_string)
* `path_string` `uri` The uri of the ittf document that will be loaded as is (no composition, non template evaluation) 
* returns an ittfMTreeEx instance 
#### ittfMTreeEx.loadFrom(mTree)
* `mTree` `Object` An existent final or partial mTree. 
* returns an ittfMTreeEx instance 
## ittfHtmlPrettifier - ittf html formatter for documentation
#### var ittfHtmlPrettifier = require('wizzi-utils').ittfHtmlPrettifier
## ittfHtmlPrettifier(rootNode[, options])
* `rootNode` `Object` ittfMTreeEx instance 
* `options` `Object` 
## jsHtmlPrettifier - javascript html formatter for documentation
#### var jsHtmlPrettifier = require('wizzi-utils').jsHtmlPrettifier
## jsHtmlPrettifier(script[, options])
* `script` `String` javascript code 
* `options` `Object` 
## Source and generation
wizzi-browser is generated using the wizzi factory ver 0.5.

## The Wizzi Factory - Ver 0.6

A set of tools for model driven development.


<p>

<a href="https://wizzifactory.github.io/">Project page
</a>

</p>

## Built With
* [Nodejs](https://nodejs.org)

* [Wizzi Factory](https://github.com/wizzifactory)


## License

<p>This project is licensed under the MIT License - see the

<a href="license.txt">license.txt
</a>


<p>for details.
</p>

</p>

---
_Source: https://npm.io/package/wizzi-browser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
