basics
Ce plugin propose une série d'instructions transformer plusieurs formats text
(xml, json, cvs, etc.) en flux d'objets Javascript
installation
npm install @ezs/basics
usage
Table of Contents
BUFObject
Take Mixed
and produce Buffer.
For example, it's useful to send string to browser.
Parameters
Returns Buffer
CSVObject
Take Array
and transform rows into object.
Each row (Array) is tranformed
into a object where keys are the value of the first row
Parameters
Returns Object
CSVParse
Take String
and parse CSV to generate object
Parameters
separator
String to indicate the CSV separator (optional, default auto
)quote
String to indicate the CSV quote. (optional, default auto
)
Returns Object
CSVString
Take Object
and transform row into string
where each field is separated with a character
Parameters
format
String if set to "strict" the fields will wrapped with double quote (optional, default standard
)separator
String to indicate the CSV separator (optional, default ;
)header
Boolean first line contains key name (optional, default true
)
Returns String
JSONParse
Take String
and parse JSON and generate objects
Parameters
separator
String to split at every JSONPath found (optional, default *
)
Returns Object
JSONString
Take Object
and generate JSON
Parameters
wrap
String every document are wrapped into an array (optional, default true
)indent
String indent JSON (optional, default false
)
Returns String
OBJCount
Take Object
and count how many objects are received and sent the total
Parameters
Returns Number
OBJFlatten
Take Object
and flat it with delimited character.
Parameters
separator
String choose a character for flatten keys (optional, default /
)safe
Boolean preserve arrays and their contents, (optional, default false
)
Returns Object
OBJStandardize
Take Object
and standardize it so each object will have the sames keys
Parameters
Returns Object
SKOSObject
Take Object
generated by XMLMapping & SKOS data and
create a new basic object with only keys & values
Parameters
Returns Object
TXTConcat
Take String
and concat all items in just one string
Parameters
Returns String
TXTObject
Take String
and generate an object with a key and a value, where the value is the input string.
Parameters
key
String choose a the key name (optional, default value
)
Returns Object
TXTParse
Take String
and split at each separator found
Parameters
separator
String choose character which trigger the split (optional, default "\n"
)
Returns String
TXTZip
Take a String and zip it
Returns Buffer
URLFetch
Take Object
and create a new field with the content of URL.
Or if no target will be specified, the output will be the content of URL
Parameters
url
String? URL to fecthtarget
String? choose the key to setjson
String Pasre as JSON the content of URL (optional, default false
)
Returns Object
URLParse
Take String
of URL, parse it and returns Object
Returns Object
URLStream
Take Object
as parameters of URL, throw each chunk from the result
Parameters
url
String? URL to fecthtarget
String? choose the key to setjson
String Pasre as JSON the content of URL (optional, default false
)
Returns Object
URLString
Take Object
representing a URL and stringify it
Returns String
XMLParse
Take String
as XML input, parse it and split it in multi document at each path found
Parameters
url
String? URL to fecthtarget
String? choose the key to setseparator
String choose a character for flatten keys (optional, default /
)
Returns Object
XMLString
Take Object
and transform it into a XML string
Parameters
rootElement
String Root element name for the tag which start and close the feed (optional, default items
)contentElement
String Content element name for the tag which start and close each item (optional, default item
)
Returns String