js-type-predict

js-type-predict is a lightweight TypeScript/JavaScript utility for predicting the data type of an array of values. It can determine whether the values in the array are strings, numbers, booleans, dates, or datetime objects.

Features

• Predicts common data types: string, number, float, boolean, date, and datetime2.
• Optionally treat 0 and 1 as boolean values.
• Lightweight and easy to use.

Installation

You can install the package via npm:

1npm install js-type-predict

Usage

Here’s a simple example of how to use js-type-predict:

1import { predictType } from 'js-type-predict';
2
3const input = {
4    values: ["2022-01-01", "2022-02-01"],
5    treatZeroOneAsBoolean: false
6};
7
8const result = predictType(input);
9console.log(result);  // Outputs: "date"

Parameters

• values: An array of values of any type.
• treatZeroOneAsBoolean (optional): A boolean flag (default is false). If set to true, 0 and 1 are treated as boolean values (false and true, respectively).

Return Value

The function returns a string representing the predicted type of the values in the array. Possible return values include:

• "string"
• "number"
• "float"
• "boolean"
• "date"
• "datetime2"

Examples

Basic Example

1import { predictType } from 'js-type-predict';
2
3let input = {
4    values: ["true", "false", "true"],
5    treatZeroOneAsBoolean: false
6};
7console.log(predictType(input));  // Outputs: "boolean"

Treating 0 and 1 as Boolean

1import { predictType } from 'js-type-predict';
2
3let input = {
4    values: ["0", "1", "1"],
5    treatZeroOneAsBoolean: true
6};
7console.log(predictType(input));  // Outputs: "boolean"

Handling Dates and Datetimes

1import { predictType } from 'js-type-predict';
2
3let input = {
4    values: ["2022-01-01T12:00:00", "2022-02-01T15:30:00"],
5    treatZeroOneAsBoolean: false
6};
7console.log(predictType(input));  // Outputs: "datetime2"

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an issue on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.