@fgv/ts-utils
Advanced tools
Comparing version 1.3.1 to 1.4.0
@@ -162,3 +162,3 @@ import { BaseConverter, Converter, ConverterTraits } from './converter'; | ||
* @remarks | ||
* Delimeter may also be supplied as context at conversion time. | ||
* Delimiter may also be supplied as context at conversion time. | ||
* @param delimiter - The delimiter at which to split. | ||
@@ -203,3 +203,3 @@ * @returns A new {@link Converter} returning `string[]`. | ||
* @param converters - An ordered list of {@link Converter | converters} to be considered. | ||
* @param onError - Specifies treatment of unconvertable elements. | ||
* @param onError - Specifies treatment of unconvertible elements. | ||
* @returns A new {@link Converter} which yields a value from the union of the types returned | ||
@@ -216,3 +216,3 @@ * by the wrapped converters. | ||
* @param converter - {@link Converter} used to convert each item in the array. | ||
* @param ignoreErrors - Specifies treatment of unconvertable elements. | ||
* @param ignoreErrors - Specifies treatment of unconvertible elements. | ||
* @returns A {@link Converter} which returns an array of `<T>`. | ||
@@ -228,3 +228,3 @@ * @public | ||
* @param converter - {@link Converter} used to convert each item in the array | ||
* @param ignoreErrors - Specifies treatment of unconvertable elements | ||
* @param ignoreErrors - Specifies treatment of unconvertible elements | ||
* @beta | ||
@@ -371,3 +371,3 @@ */ | ||
* @remarks | ||
* The resulting {@link Converter} returns {@link Success} with the converted value if the element exsist | ||
* The resulting {@link Converter} returns {@link Success} with the converted value if the element exists | ||
* in the supplied array and can be converted. Returns {@link Success} with value `undefined` if the parameter | ||
@@ -386,3 +386,3 @@ * is an array but the index is out of range. Returns {@link Failure} with a message if the supplied parameter | ||
* @remarks | ||
* The resulting {@link Converter} returns {@link Success} with the converted value of the correpsonding | ||
* The resulting {@link Converter} returns {@link Success} with the converted value of the corresponding | ||
* object property if the field exists and can be converted. Returns {@link Failure} with an error message | ||
@@ -399,5 +399,5 @@ * otherwise. | ||
* @remarks | ||
* The resulting {@link Converter} returns {@link Success} with the converted value of the correpsonding | ||
* The resulting {@link Converter} returns {@link Success} with the converted value of the corresponding | ||
* object property if the field exists and can be converted. Returns {@link Success} with value `undefined` | ||
* if the supplied parametr is an object but the named field is not present. Returns {@link Failure} with | ||
* if the supplied parameter is an object but the named field is not present. Returns {@link Failure} with | ||
* an error message otherwise. | ||
@@ -500,6 +500,6 @@ * @param name - The name of the field to be extracted. | ||
* without changing shape, given a {@link Converters.FieldConverters | FieldConverters<T>} and an optional | ||
* {@link Converters.ObjectConverterOptions | ObjectConverterOptions<T>} to further refine conversion beavior. | ||
* {@link Converters.ObjectConverterOptions | ObjectConverterOptions<T>} to further refine conversion behavior. | ||
* @remarks | ||
* By default, if all of the requested fields exist and can be converted, returns {@link Success} | ||
* with a new object that contains the converted values under the original key names. If any requried properties | ||
* with a new object that contains the converted values under the original key names. If any required properties | ||
* do not exist or cannot be converted, the entire conversion fails, returning {@link Failure} with additional | ||
@@ -525,3 +525,3 @@ * error information. | ||
* By default, if all of the requested fields exist and can be converted, returns {@link Success} | ||
* with a new object that contains the converted values under the original key names. If any requried properties | ||
* with a new object that contains the converted values under the original key names. If any required properties | ||
* do not exist or cannot be converted, the entire conversion fails, returning {@link Failure} with additional | ||
@@ -592,3 +592,3 @@ * error information. | ||
/** | ||
* Helper to create a {@link Converter} whhich converts a discriminated object without changing shape. | ||
* Helper to create a {@link Converter} which converts a discriminated object without changing shape. | ||
* @remarks | ||
@@ -595,0 +595,0 @@ * Takes the name of the discriminator property and a |
@@ -8,2 +8,3 @@ export * from './brand'; | ||
export * from './utils'; | ||
export { Normalizer } from './normalize'; | ||
import * as Converters from './converters'; | ||
@@ -10,0 +11,0 @@ import * as Csv from './csvHelpers'; |
@@ -29,3 +29,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.Validation = exports.Hash = exports.Csv = exports.Converters = void 0; | ||
exports.Validation = exports.Hash = exports.Csv = exports.Converters = exports.Normalizer = void 0; | ||
/* | ||
@@ -59,2 +59,4 @@ * Copyright (c) 2020 Erik Fortune | ||
__exportStar(require("./utils"), exports); | ||
var normalize_1 = require("./normalize"); | ||
Object.defineProperty(exports, "Normalizer", { enumerable: true, get: function () { return normalize_1.Normalizer; } }); | ||
const Converters = __importStar(require("./converters")); | ||
@@ -68,2 +70,2 @@ exports.Converters = Converters; | ||
exports.Validation = Validation; | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvQkc7QUFDSCwwQ0FBd0I7QUFDeEIsOENBQTRCO0FBQzVCLGtEQUFnQztBQUNoQyw4Q0FBNEI7QUFDNUIsNENBQTBCO0FBQzFCLDJDQUF5QjtBQUN6QiwwQ0FBd0I7QUFFeEIseURBQTJDO0FBSWxDLGdDQUFVO0FBSG5CLGtEQUFvQztBQUdmLGtCQUFHO0FBRnhCLDZDQUErQjtBQUVMLG9CQUFJO0FBRDlCLHlEQUEyQztBQUNYLGdDQUFVIiwic291cmNlc0NvbnRlbnQiOlsiLypcbiAqIENvcHlyaWdodCAoYykgMjAyMCBFcmlrIEZvcnR1bmVcbiAqXG4gKiBQZXJtaXNzaW9uIGlzIGhlcmVieSBncmFudGVkLCBmcmVlIG9mIGNoYXJnZSwgdG8gYW55IHBlcnNvbiBvYnRhaW5pbmcgYSBjb3B5XG4gKiBvZiB0aGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmlsZXMgKHRoZSBcIlNvZnR3YXJlXCIpLCB0byBkZWFsXG4gKiBpbiB0aGUgU29mdHdhcmUgd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRhdGlvbiB0aGUgcmlnaHRzXG4gKiB0byB1c2UsIGNvcHksIG1vZGlmeSwgbWVyZ2UsIHB1Ymxpc2gsIGRpc3RyaWJ1dGUsIHN1YmxpY2Vuc2UsIGFuZC9vciBzZWxsXG4gKiBjb3BpZXMgb2YgdGhlIFNvZnR3YXJlLCBhbmQgdG8gcGVybWl0IHBlcnNvbnMgdG8gd2hvbSB0aGUgU29mdHdhcmUgaXNcbiAqIGZ1cm5pc2hlZCB0byBkbyBzbywgc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6XG4gKlxuICogVGhlIGFib3ZlIGNvcHlyaWdodCBub3RpY2UgYW5kIHRoaXMgcGVybWlzc2lvbiBub3RpY2Ugc2hhbGwgYmUgaW5jbHVkZWQgaW4gYWxsXG4gKiBjb3BpZXMgb3Igc3Vic3RhbnRpYWwgcG9ydGlvbnMgb2YgdGhlIFNvZnR3YXJlLlxuICpcbiAqIFRIRSBTT0ZUV0FSRSBJUyBQUk9WSURFRCBcIkFTIElTXCIsIFdJVEhPVVQgV0FSUkFOVFkgT0YgQU5ZIEtJTkQsIEVYUFJFU1MgT1JcbiAqIElNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLFxuICogRklUTkVTUyBGT1IgQSBQQVJUSUNVTEFSIFBVUlBPU0UgQU5EIE5PTklORlJJTkdFTUVOVC4gSU4gTk8gRVZFTlQgU0hBTEwgVEhFXG4gKiBBVVRIT1JTIE9SIENPUFlSSUdIVCBIT0xERVJTIEJFIExJQUJMRSBGT1IgQU5ZIENMQUlNLCBEQU1BR0VTIE9SIE9USEVSXG4gKiBMSUFCSUxJVFksIFdIRVRIRVIgSU4gQU4gQUNUSU9OIE9GIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLFxuICogT1VUIE9GIE9SIElOIENPTk5FQ1RJT04gV0lUSCBUSEUgU09GVFdBUkUgT1IgVEhFIFVTRSBPUiBPVEhFUiBERUFMSU5HUyBJTiBUSEVcbiAqIFNPRlRXQVJFLlxuICovXG5leHBvcnQgKiBmcm9tICcuL2JyYW5kJztcbmV4cG9ydCAqIGZyb20gJy4vY29udmVydGVyJztcbmV4cG9ydCAqIGZyb20gJy4vZXh0ZW5kZWRBcnJheSc7XG5leHBvcnQgKiBmcm9tICcuL2Zvcm1hdHRlcic7XG5leHBvcnQgKiBmcm9tICcuL3JhbmdlT2YnO1xuZXhwb3J0ICogZnJvbSAnLi9yZXN1bHQnO1xuZXhwb3J0ICogZnJvbSAnLi91dGlscyc7XG5cbmltcG9ydCAqIGFzIENvbnZlcnRlcnMgZnJvbSAnLi9jb252ZXJ0ZXJzJztcbmltcG9ydCAqIGFzIENzdiBmcm9tICcuL2NzdkhlbHBlcnMnO1xuaW1wb3J0ICogYXMgSGFzaCBmcm9tICcuL2hhc2gnO1xuaW1wb3J0ICogYXMgVmFsaWRhdGlvbiBmcm9tICcuL3ZhbGlkYXRpb24nO1xuZXhwb3J0IHsgQ29udmVydGVycywgQ3N2LCBIYXNoLCBWYWxpZGF0aW9uIH07XG4iXX0= | ||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQTs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FvQkc7QUFDSCwwQ0FBd0I7QUFDeEIsOENBQTRCO0FBQzVCLGtEQUFnQztBQUNoQyw4Q0FBNEI7QUFDNUIsNENBQTBCO0FBQzFCLDJDQUF5QjtBQUN6QiwwQ0FBd0I7QUFDeEIseUNBQXlDO0FBQWhDLHVHQUFBLFVBQVUsT0FBQTtBQUVuQix5REFBMkM7QUFJbEMsZ0NBQVU7QUFIbkIsa0RBQW9DO0FBR2Ysa0JBQUc7QUFGeEIsNkNBQStCO0FBRUwsb0JBQUk7QUFEOUIseURBQTJDO0FBQ1gsZ0NBQVUiLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IChjKSAyMDIwIEVyaWsgRm9ydHVuZVxuICpcbiAqIFBlcm1pc3Npb24gaXMgaGVyZWJ5IGdyYW50ZWQsIGZyZWUgb2YgY2hhcmdlLCB0byBhbnkgcGVyc29uIG9idGFpbmluZyBhIGNvcHlcbiAqIG9mIHRoaXMgc29mdHdhcmUgYW5kIGFzc29jaWF0ZWQgZG9jdW1lbnRhdGlvbiBmaWxlcyAodGhlIFwiU29mdHdhcmVcIiksIHRvIGRlYWxcbiAqIGluIHRoZSBTb2Z0d2FyZSB3aXRob3V0IHJlc3RyaWN0aW9uLCBpbmNsdWRpbmcgd2l0aG91dCBsaW1pdGF0aW9uIHRoZSByaWdodHNcbiAqIHRvIHVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwgcHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGxcbiAqIGNvcGllcyBvZiB0aGUgU29mdHdhcmUsIGFuZCB0byBwZXJtaXQgcGVyc29ucyB0byB3aG9tIHRoZSBTb2Z0d2FyZSBpc1xuICogZnVybmlzaGVkIHRvIGRvIHNvLCBzdWJqZWN0IHRvIHRoZSBmb2xsb3dpbmcgY29uZGl0aW9uczpcbiAqXG4gKiBUaGUgYWJvdmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGljZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGxcbiAqIGNvcGllcyBvciBzdWJzdGFudGlhbCBwb3J0aW9ucyBvZiB0aGUgU29mdHdhcmUuXG4gKlxuICogVEhFIFNPRlRXQVJFIElTIFBST1ZJREVEIFwiQVMgSVNcIiwgV0lUSE9VVCBXQVJSQU5UWSBPRiBBTlkgS0lORCwgRVhQUkVTUyBPUlxuICogSU1QTElFRCwgSU5DTFVESU5HIEJVVCBOT1QgTElNSVRFRCBUTyBUSEUgV0FSUkFOVElFUyBPRiBNRVJDSEFOVEFCSUxJVFksXG4gKiBGSVRORVNTIEZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklOR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEVcbiAqIEFVVEhPUlMgT1IgQ09QWVJJR0hUIEhPTERFUlMgQkUgTElBQkxFIEZPUiBBTlkgQ0xBSU0sIERBTUFHRVMgT1IgT1RIRVJcbiAqIExJQUJJTElUWSwgV0hFVEhFUiBJTiBBTiBBQ1RJT04gT0YgQ09OVFJBQ1QsIFRPUlQgT1IgT1RIRVJXSVNFLCBBUklTSU5HIEZST00sXG4gKiBPVVQgT0YgT1IgSU4gQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBUSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRVxuICogU09GVFdBUkUuXG4gKi9cbmV4cG9ydCAqIGZyb20gJy4vYnJhbmQnO1xuZXhwb3J0ICogZnJvbSAnLi9jb252ZXJ0ZXInO1xuZXhwb3J0ICogZnJvbSAnLi9leHRlbmRlZEFycmF5JztcbmV4cG9ydCAqIGZyb20gJy4vZm9ybWF0dGVyJztcbmV4cG9ydCAqIGZyb20gJy4vcmFuZ2VPZic7XG5leHBvcnQgKiBmcm9tICcuL3Jlc3VsdCc7XG5leHBvcnQgKiBmcm9tICcuL3V0aWxzJztcbmV4cG9ydCB7IE5vcm1hbGl6ZXIgfSBmcm9tICcuL25vcm1hbGl6ZSc7XG5cbmltcG9ydCAqIGFzIENvbnZlcnRlcnMgZnJvbSAnLi9jb252ZXJ0ZXJzJztcbmltcG9ydCAqIGFzIENzdiBmcm9tICcuL2NzdkhlbHBlcnMnO1xuaW1wb3J0ICogYXMgSGFzaCBmcm9tICcuL2hhc2gnO1xuaW1wb3J0ICogYXMgVmFsaWRhdGlvbiBmcm9tICcuL3ZhbGlkYXRpb24nO1xuZXhwb3J0IHsgQ29udmVydGVycywgQ3N2LCBIYXNoLCBWYWxpZGF0aW9uIH07XG4iXX0= |
{ | ||
"name": "@fgv/ts-utils", | ||
"version": "1.3.1", | ||
"version": "1.4.0", | ||
"description": "Assorted Typescript Utilities", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
78
642770
5872