\n \n \n
Grab bag of utilities for vandelay transform functions.
\n\n\n# vandelay-util [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url]\n\n\n## Install\n\n```\nnpm install vandelay-util --save\n```\n\n## Utilities\n\nUtility functions will return undefined when given null or invalid values when appropriate.\n\nFor example:\n\n```js\nconst row = {\n name: 'pear'\n}\n\nutil.capitalize(row.notes) // undefined\nutil.convert(row.speed).from('m/h').to('km/h') // undefined\n```\n\n#### util.guid(...values)\n\nStringifies all provided values and turns them into a deterministic GUID. Null values are ignored.\n\n```js\nutil.guid('Michael Scott', 'Birthday', null, 1993) // f8e61be1-0b1c-4e4f-81b6-050ae9b8a049\n```\n\n#### util.slug(...values)\n\nStringifies all provided values and turns them into a lowercase slug. Null values are ignored.\n\n**Note:** This function will remove many characters, including non-english characters. Use with caution if you are using this for a unique ID.\n\n```js\nutil.slug('Michael Scott', 'Birthday', null, 1993) // michael-scott-birthday-1993\n```\n\n#### util.normalize(value)\n\nTrims, lowercases, and removes redundant whitespace from the given value.\n\n```js\nutil.normalize('\\t HEY \\n THANKS') // hey thanks\n```\n\n#### util.capitalize(value)\n\nCapitalizes the first word in the given value.\n\n#### util.capitalize.words(value)\n\nCapitalizes every word in the given value.\n\n#### util.camelize(value)\n\nCamelcases the given value.\n\n#### util.decamelize(value)\n\nConverts camelcase to non-camelcase - separated by spaces.\n\n#### util.phone(value[, country])\n\nNormalizes any phone number in the world. Country is any three letter country code, defaulting to `'USA'`. If the number includes a country code, you do not need to provide a `country` argument.\n\n```js\nutil.phone(' 123 ') // undefined\nutil.phone(123) // undefined\n\n// USA numbers\nutil.phone('4805335949') // +14805335949\nutil.phone('(480) 533-5949') // +14805335949\nutil.phone('480-533-5949') // +14805335949\nutil.phone(4805335949) // +14805335949\n\n// Hong Kong numbers\nutil.phone('6123-6123') // undefined\nutil.phone('6123-6123', 'HKG') // +85261236123\nutil.phone('+852 6123-6123') // +85261236123\n})\n```\n\n#### util.convert(value)\n\nExposes convert-units, with additional handling of null and invalid values. For a full list of convertible units, see [this page](https://github.com/ben-ng/convert-units#supported-units).\n\n```js\nutil.convert(null).from('m/h').to('km/h') // undefined\nutil.convert('1').from('F').to('C') // -17.22222222222222\nutil.convert(1).from('mi').to('km') // 1.6093439485009937\n```\n\n#### util.moment(value)\n\nExposes moment + moment-timezone, with additional handling of null and invalid values. For a full list of time zones, see [this page](https://momentjs.com/timezone/).\n\n```js\nutil.moment(null) // undefined\nutil.moment('12/27/1993') // moment object\nutil.moment.tz('12/27/1993', 'America/New_York') // moment object\n```\n\n#### util.memo(function)\n\nExposes memoization helpers, with additional handling of null and invalid values. For a full usage guide, see [this page](https://github.com/planttheidea/moize#usage).\n\n```js\n// Fetch a request only once\nconst getLocationData = util.memo.promise(async () =>\n util.request('http://google.com/fetch-only-once.json')\n)\n\n// Cache synchronous computation\nconst getTotal = util.memo((data) => {\n return data\n .map((i) => i.count)\n .reduce((prev, curr) =>\n prev + curr\n , 0)\n})\n```\n\n#### util.date(value, timezone)\n\nWrapper around moment.js `moment.tz(date, timezone)` that handles null and invalid values. Search timezones [here](https://momentjs.com/timezone/).\n\n```js\nutil.date('abc', 'America/New_York') // undefined\nutil.date(null, 'America/Los_Angeles') // undefined\nutil.date('12/27/1993', 'America/New_York') // 1993-12-27T05:00:00.000Z\n```\n\n#### util.number(value)\n\nWrapper around number parsing that handles null and invalid values.\n\n```js\nutil.number('$100.56') // 100.56\nutil.number(100.56) // 100.56\nutil.number('costs $100.56') // 100.56\nutil.number('it is -100.56') // -100.56\n```\n\n#### util.geo.isSea(value)\n\nReturns true if the coordinate is in the sea. Value can be either `[ lon, lat ]` or a GeoJSON Point.\n\n```js\nutil.geo.isSea([ 0, 0 ]) // true\n```\n\n#### util.geo.tz(point)\n\nReturns the timezone for a given point. Value returned can be used as the timezone for `util.date`. Value can be either `[ lon, lat ]` or a GeoJSON Point.\n\n```js\nutil.geo.tz([ -118.250587 , 34.031179 ]) // America/Los_Angeles\n\nutil.geo.tz({\n type: 'Point',\n coordinates: [ 121.456424, 31.224417 ]\n}) // Asia/Shanghai\n```\n\n#### util.geo.reproject(geojson[, sourceProjection])\n\nParses GeoJSON and reprojects it into WGS84. If the GeoJSON has a `crs` attribute it will auto-detect it, otherwise you can specify it as the second argument.\n\n```js\n// Auto-detection based on the input data\nutil.geo.reproject({\n type: 'Point',\n crs: {\n type: 'name',\n properties: {\n name: 'EPSG:3006'\n }\n },\n coordinates: [\n 319180,\n 6399862\n ]\n}) // { type: 'Point', coordinates: [ 11.965261850066433, 57.704505637111694 ] }\n\n\n// Manually specifying it, any EPSG code or URN is acceptable\nutil.geo.reproject({\n type: 'Point',\n coordinates: [\n 319180,\n 6399862\n ]\n}, 'EPSG:3006') // { type: 'Point', coordinates: [ 11.965261850066433, 57.704505637111694 ] }\n```\n\n#### util.geo.multi(value)\n\nConverts any given GeoJSON geometry to a `Multi` version. Values that are already a `Multi` geometry will be returned with no modifications.\n\n```js\nutil.geo.multi({\n type: 'Polygon',\n coordinates: [\n [ [ 100.0, 0.0 ], [ 101.0, 0.0 ], [ 101.0, 1.0 ], [ 100.0, 1.0 ], [ 100.0, 0.0 ] ],\n [ [ 100.2, 0.2 ], [ 100.8, 0.2 ], [ 100.8, 0.8 ], [ 100.2, 0.8 ], [ 100.2, 0.2 ] ]\n ]\n})\n```\n\n#### util.geo.simplify(value)\n\nSimplifies any given GeoJSON geometry to the precision of a meter. Values that do not need simplification will be returned with no modifications.\n\n```js\nutil.geo.simplify({\n type: 'Polygon',\n coordinates: [\n [ [ 100.0, 0.0 ], [ 101.0, 0.0 ], [ 101.0, 1.0 ], [ 100.0, 1.0 ], [ 100.0, 0.0 ] ],\n [ [ 100.2, 0.2 ], [ 100.8, 0.2 ], [ 100.8, 0.8 ], [ 100.2, 0.8 ], [ 100.2, 0.2 ] ]\n ]\n})\n```\n\n#### util.geo.wk2JSON(value)\n\nConverts Well-Known-Text to GeoJSON - supports WKT/WKB/EWKT/EWKB/TWKB.\n\n```js\nutil.geo.wk2JSON('POINT(1 2)') // { type: 'Point', coordinates: [1, 2] }\n```\n\n#### util.geo.intersection({ intersection, city, region, country, sources })\n\nReturns a geopoint for an intersection. For example:\n\n```js\nutil.geo.intersection({\n intersection: '12th Ave./Hammond St.',\n city: 'Lost Wages',\n region: 'NV',\n country: 'USA'\n})\n\nutil.geo.intersection({\n intersection: '24th Ave., Avery St.',\n city: 'Lost Wages',\n region: 'NV',\n country: 'USA'\n})\n```\n\n#### util.geo.locate({ address, city, region, postalCode, country, minConfidence, filter, sources, layers })\n#### util.geo.search({ text, minConfidence, filter, sources, layers })\n#### util.geo.snap({ type, path, optional, sources })\n#### util.geo.navigate({ type, start, end, optional, sources })\n\n#### util.geo.turf\n\nExposes [turf](http://turfjs.org/) with no modifications.\n\n#### util._\n\nExposes [lodash](https://lodash.com/) with no modifications.\n\n#### util.validator\n\nExposes [validator](https://github.com/chriso/validator.js#validators) with no modifications.\n\n#### util.request\n\nExposes [superagent](https://visionmedia.github.io/superagent/) with no modifications.\n\n#### util.sdk\n\nExposes [stae js-sdk](https://github.com/staeco-js-sdk) with no modifications.\n\n[downloads-image]: http://img.shields.io/npm/dm/vandelay-util.svg\n[npm-url]: https://npmjs.org/package/vandelay-util\n[npm-image]: http://img.shields.io/npm/v/vandelay-util.svg\n\n[travis-url]: https://travis-ci.org/staeco/vandelay-util\n[travis-image]: https://travis-ci.org/staeco/vandelay-util.png?branch=master\n","readmeFilename":"README.md","contributors":[{"name":"Contra","email":"yo@contra.io","url":"http://contra.io"}]}