Appearance
entanclature package
A library for Entanglement Nomenclature.
Remarks
This module exports only one function entanclature to handle the Entanglement Nomenclature. entanclature accepts a URL or file path (Node.js only) as an argument and it always returns a fixed data structure.
Functions
| Function | Description |
|---|---|
| fromFile(path, meta, opts) | *Process the image from the file path. |
| fromURL(url) | *Process the image from the URL. |
| router(url) | *Route for different parameters. |
| router(path, meta, opts) | *Route for different parameters. |
Variables
| Variable | Description |
|---|---|
| entanclature | This is the main function of this project! |
| GRAMMAR | The relationship between MIME Type, Mark and Ext. |
Type Aliases
| Type Alias | Description |
|---|---|
| Decoded | All the information needed to encode an image. |
| Encoded | Record the encoded information. |
| Ext | Available file extensions. |
| Mark | Available type identifiers. |
| Meta | An array, describe how to transform the images. |
| Opts | Set baseURL, fileDir and an optional ext. |
| Quality | Available quality identifiers. |
| Result | the results. |
| Type | Available MIME types. |
| ValueOf | Get all possible values of T. |