resolveTypeString

Type:Function

Status:beta

Since:1.0.0

Platform:node

@blackbyte.sugar.node.type

This method simply parse the passed typeString like “string | number”, or “string & path”, etc… and return an object defining the resolved type with interface if defined, etc…

Params

typeString*-String
The type string to parse
settings{}Partial<TResolveTypeStringSettings>
A setting object to configure your resolve process

Return

-Promise<TResolveTypeStringResult>
A promise resolved once the type string has been resolved

Example

import { resolveTypeString } from '@blackbyte/sugar/type';
resolveTypeString('string');
// {
//    types: [{
//       type: 'string',
//       of: undefined,
//       value: undefined
//    }],
// }

Settings

cwdprocess.cwd()String
The cwd to use to resolve the type string when they are path

Author

Olivier Bosselolivier.bossel@gmail.com