typof 1.0.2 → 1.0.3

package/README.md

@@ -40,13 +40,13 @@
 
 ## About
 
-Extract the valid types.
+Infer types.
 
 ## Features
 
-- Extract multiple types
-- Extracts integer and float types
-- It infers the type from a string
+- Infers multiple types
+- Infers integer and float types
+- Infers the type from a string
 - There are simple type converters
 
 ## Installation
@@ -83,7 +83,6 @@ typof
 ├── string(value)
 ├── number(value)
 ├── integer(value)
-├── float(value)
 ├── boolean(value)
 ├── object(value)
 ├── array(value)
@@ -104,7 +103,7 @@ import { typof } from 'typof';
 
 `typof(value)`
 
-Extract the valid types.
+Infers types.
 
 > | Parameter | Default | Description                         |
 > | --------- | ------- | ----------------------------------- |
@@ -115,36 +114,173 @@ Extract the valid types.
 > Example:
 >
 > ```typescript
-> typof('test'); // [ 'string' ]
+> typof('test'); // [ "string" ]
 >
-> typof('0'); // [ 'string', 'number', 'integer' ]
-> typof(0); // [ 'number', 'integer' ]
+> typof('0'); // [ "string", "number", "integer" ]
+> typof(0); // [ "number", "integer" ]
 >
-> typof('0.5'); // [ 'string', 'number', 'float' ]
-> typof(0.5); // [ 'number', 'float' ]
+> typof('0.5'); // [ "string", "number", "float" ]
+> typof(0.5); // [ "number", "float" ]
 >
-> typof('true'); // [ 'string', 'boolean' ]
-> typof(true); // [ 'boolean' ]
+> typof('true'); // [ "string", "boolean" ]
+> typof(true); // [ "boolean" ]
 >
-> typof('{"key": "value"}'); // [ 'string', 'object' ]
-> typof({ key: 'value' }); // [ 'object' ]
+> typof('{"key": "value"}'); // [ "string", "object" ]
+> typof({ key: 'value' }); // [ "object" ]
 >
-> typof('["test"]'); // [ 'string', 'array' ]
-> typof(['test']); // [ 'array' ]
+> typof('["test"]'); // [ "string", "array" ]
+> typof(['test']); // [ "array" ]
 >
-> typof('2025-01-01'); // [ 'string', 'date' ]
-> typof(new Date('2025-01-01')); // [ 'object', 'date' ]
+> typof('2025-01-01'); // [ "string", "date" ]
+> typof(new Date('2025-01-01')); // [ "object", "date" ]
 >
-> typof('null'); // [ 'string, 'null' ]
-> typof(null); // [ 'null' ]
+> typof('null'); // [ "string", "null" ]
+> typof(null); // [ "null" ]
 >
-> typof('undefined'); // [ 'string, 'undefined' ]
-> typof(undefined); // [ 'undefined' ]
+> typof('undefined'); // [ "string", "undefined" ]
+> typof(undefined); // [ "undefined" ]
 >
 > // Tests are as follows. (Is this an integer?)
 > if (typof(0).includes('integer')) console.log('This is an integer!');
 > ```
 
+<br/>
+
+`string(value)`
+
+Convert to string.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [String]
+>
+> Example:
+>
+> ```typescript
+> string(0.5); // "0.5"
+> string(true); // "true"
+> string({ key: 'value' }); // '{"key":"value"}'
+> string(['test']); // '["test"]'
+> string(new Date('2025-01-01')); // "2025-01-01T00:00:00.000Z"
+> string(null); // "null"
+> string(undefined); // "undefined"
+> ```
+
+<br/>
+
+`number(value)`
+
+Convert to number.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [Number]
+>
+> Example:
+>
+> ```typescript
+> number('0.5'); // 0.5
+> ```
+
+<br/>
+
+`integer(value)`
+
+Convert to integer.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [Number]
+>
+> Example:
+>
+> ```typescript
+> integer('0.5'); // 0
+> integer(0.5); // 0
+> ```
+
+<br/>
+
+`boolean(value)`
+
+Convert to boolean.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [Boolean] | Value
+>
+> Example:
+>
+> ```typescript
+> boolean('true'); // true
+> boolean(true); // true
+> boolean('test'); // "test"
+> ```
+
+<br/>
+
+`object(value)`
+
+Convert to object.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [Object] | Value
+>
+> Example:
+>
+> ```typescript
+> object('{"key":"value"}'); // { key: "value" }
+> object('["test"]'); // '["test"]'
+> ```
+
+<br/>
+
+`array(value)`
+
+Convert to array.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [Array] | Value
+>
+> Example:
+>
+> ```typescript
+> array('["test"]'); // [ "test" ]
+> array('{"key":"value"}'); // '{"key":"value"}'
+> ```
+
+<br/>
+
+`date(value)`
+
+Convert to date.
+
+> | Parameter | Default | Description                   |
+> | --------- | ------- | ----------------------------- |
+> | value     |         | Unknown<br/>Value to convert. |
+>
+> returns [Array] | Value
+>
+> Example:
+>
+> ```typescript
+> date('2025-01-01'); // 2025-01-01T00:00:00.000Z
+> ```
+
 ### Types
 
 | Type    |

package/dist/main.d.mts

@@ -4,10 +4,9 @@ declare const typof: (value: unknown) => Types[];
 declare const string: (value: unknown) => string;
 declare const number: (value: unknown) => number;
 declare const integer: (value: unknown) => number;
-declare const float: (value: unknown) => number;
 declare const boolean: <Value>(value: Value) => boolean | Value;
 declare const object: <Value>(value: Value) => object | Value;
 declare const array: <Value>(value: Value) => unknown[] | Value;
 declare const date: (value: unknown) => Date;
 
-export { type Types, array, boolean, date, float, integer, number, object, string, typof };
+export { type Types, array, boolean, date, integer, number, object, string, typof };

package/dist/main.d.ts

@@ -4,10 +4,9 @@ declare const typof: (value: unknown) => Types[];
 declare const string: (value: unknown) => string;
 declare const number: (value: unknown) => number;
 declare const integer: (value: unknown) => number;
-declare const float: (value: unknown) => number;
 declare const boolean: <Value>(value: Value) => boolean | Value;
 declare const object: <Value>(value: Value) => object | Value;
 declare const array: <Value>(value: Value) => unknown[] | Value;
 declare const date: (value: unknown) => Date;
 
-export { type Types, array, boolean, date, float, integer, number, object, string, typof };
+export { type Types, array, boolean, date, integer, number, object, string, typof };

package/dist/main.js

@@ -23,7 +23,6 @@ __export(main_exports, {
   array: () => array,
   boolean: () => boolean,
   date: () => date,
-  float: () => float,
   integer: () => integer,
   number: () => number,
   object: () => object,
@@ -104,9 +103,8 @@ var number = (value) => {
   return typof(value).includes("number") ? Number(value) : NaN;
 };
 var integer = (value) => {
-  return typof(value).includes("number") ? Number.parseInt(string(value)) : NaN;
+  return typof(value).includes("number") ? Math.trunc(Number(value)) : NaN;
 };
-var float = number;
 var boolean = (value) => {
   if (typof(value).includes("boolean") && typof(value).includes("string")) {
     if (value === "true") {
@@ -134,7 +132,6 @@ var date = (value) => {
   array,
   boolean,
   date,
-  float,
   integer,
   number,
   object,

package/dist/main.mjs

@@ -70,9 +70,8 @@ var number = (value) => {
   return typof(value).includes("number") ? Number(value) : NaN;
 };
 var integer = (value) => {
-  return typof(value).includes("number") ? Number.parseInt(string(value)) : NaN;
+  return typof(value).includes("number") ? Math.trunc(Number(value)) : NaN;
 };
-var float = number;
 var boolean = (value) => {
   if (typof(value).includes("boolean") && typof(value).includes("string")) {
     if (value === "true") {
@@ -99,7 +98,6 @@ export {
   array,
   boolean,
   date,
-  float,
   integer,
   number,
   object,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typof",
-  "version": "1.0.2",
-  "description": "Extract the valid types.",
+  "version": "1.0.3",
+  "description": "Infer types.",
   "license": "MIT",
   "homepage": "https://github.com/keift/typof",
   "bugs": "https://github.com/keift/typof/issues",
@@ -29,7 +29,13 @@
   "keywords": [
     "type",
     "typeof",
+    "string",
+    "number",
     "integer",
-    "float"
+    "float",
+    "boolean",
+    "object",
+    "array",
+    "date"
   ]
 }