oftypes

___

###### Configurable 'typeof' analysis and responses. Javascript ESModule.

___

Index of contents

- Installation
- Description
- Oftypes API
- array_
- arraybuffer_
- async_
- bigint_
- boolean_
- buffer_
- dataview_
- empty_
- error_
- function_
- map_
- nan_
- null_
- number_
- object_
- promise_
- set_
- string_
- symbol_
- undefined_
- NOT Oftype Functions
- oftype_ enhanced typeof
- resolvers
- JetBrains OSS Licence

___

Installation

``shell
npm install oftypes
`

____

Description

Simple and useful module to check data types.
Every method, related to retrieve data types, accepts the same parameters variable and resolvers.
Exception done for the methods:

- number_
- oftype_ enhanced typeof.

$3

- Array
- ArrayBuffer
- AsyncFunction
- BigInt
- Boolean
- Buffer
- DataView
- Empty (string, array, object, map, set, arraybuffer, dataview, buffer)
- Error
- Function
- Map
- NaN
- Null
- Number
- Object
- Promise
- Set
- String
- Symbol
- Undefined

____

Oftypes API

___

$3

signature
array_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { array_ } from 'oftypes'

console.log( await array_( [ 1 ] ) )

// prints true
`

`js
import { array_ } from 'oftypes'

console.log( await array_( 10 ) )

// prints false
`

___

$3

signature
array_buffer_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { arraybuffer_ } from 'oftypes'

console.log( await arraybuffer_( new ArrayBuffer( 1 ) ) )

// prints true
`

`js
import { arraybuffer_ } from 'oftypes'

console.log( await arraybuffer_( 10 ) )

// prints false
`

___

$3

signature
async_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { async_ } from 'oftypes'

const variable = [ async() => {} ]
const resolvers = undefined

console.log( await async_( variable[ 0 ] ) )

// prints true
`

`js
import { async_ } from 'oftypes'

const variable = new Promise( resolve => resolve( 'promise' ) )

console.log( await async_( variable ) )

// prints false
`

___

$3

signature
bigint_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { bigint_ } from 'oftypes'

const variable = BigInt( 'oftypes' )

console.log( await bigint_( variable ) )
// prints true
`

`js
import { bigint_ } from 'oftypes'

const variable = function ( ){}

console.log( await bigint_( variable ) )
// prints false
`
___

$3

signature
boolean_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { boolean_ } from 'oftypes'

const variable = { object: () => {} }
const resolvers = { true: 'it is oftype boolean!', false: 'it is not oftype boolean' }

console.log( await boolean_( variable, resolvers ) )

// prints 'it is not oftype boolean!
`

`js
import { boolean_ } from 'oftypes'

const variable = true
const resolvers = { true: 'it is oftype boolean!', false: 'it is not oftype boolean' }

console.log( await boolean_( variable, resolvers ) )

// prints 'it is oftype boolean!'
`
___

$3

signature
buffer_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { buffer_ } from 'oftypes'

const variable = Buffer.from('hello folks')
const resolvers = { true: 'it is oftype buffer!', false: 'it is NOT oftype buffer' }

console.log( await buffer_( variable, resolvers ) )

// prints 'it is oftype buffer!'
`

`js
import { buffer_ } from 'oftypes'

const variable = 'hello folks'
const resolvers = { true: 'it is oftype buffer!', false: 'it is NOT oftype buffer' }

console.log( await buffer_( variable, resolvers ) )

// prints 'it is NOT oftype buffer!'
`

___

$3

signature
dataview_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { dataview_ } from 'oftypes'

const variable = new DataView(new ArrayBuffer(1))

console.log( await dataview_( variable ) )

// prints true
`

`js
import { dataview_ } from 'oftypes'

const variable = 'reference not found'

console.log( await dataview_( variable ) )

// prints false
`
___

$3

signature
empty_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { empty_ } from 'oftypes'

console.log( await empty_( [] ) )

// prints true
`

`js
import { empty_ } from 'oftypes'

console.log( await empty_( false ) )

// prints false
`

___

$3

signature
error_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { error_ } from 'oftypes'

const variable = new ReferenceError('reference not found')

console.log( await error_( variable ) )

// prints true
`

`js
import { error_ } from 'oftypes'

const variable = 'reference not found'

console.log( await error_( variable ) )

// prints false
`

___

$3

signature
function_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { function_ } from 'oftypes'

const variable = 10

console.log( await function_( variable ) )

// prints false
`

`js
import { function_ } from 'oftypes'

const variable = () => { console.log( 'I\'m a FUNCTION!' ) }
const resolvers = { true: true, false: false }

const resolved = await function_( variable, resolvers )
resolved()

// prints I'm a FUNCTION!
`

___

$3

signature
map_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { map_ } from 'oftypes'

console.log( await map_( new Map() ) )

// prints true
`

`js
import { map_ } from 'oftypes'

console.log( await map_( new Set() ) )

// prints false
`

___

$3

signature
nan_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { nan_ } from 'oftypes'

const variable = 10
const resolvers = { true: 'it is NaN!', false: 'it is not NaN' }

console.log( await nan_( variable, resolvers ) )

// prints it is not NaN!
`

`js
import { nan_ } from 'oftypes'

const variable = { object: null }
const resolvers = { true: 'it is NaN!', false: 'it is not NaN' }

console.log( await nan_( variable.object, resolvers ) )

// prints it is NaN!
`

___

$3

signature
null_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { null_ } from 'oftypes'

const variable = { object: null }
const resolvers = { true: 'it is null!', false: 'it is not null' }

console.log( await null_( variable, resolvers ) )

// prints it is not null!
`

`js
import { null_ } from 'oftypes'

const variable = { object: null }
const resolvers = { true: 'it is null!', false: 'it is not null' }

console.log( await null_( variable.object, resolvers, payback ) )

// prints it is null!
`

___

$3

signature
number_( variable: any, [ resolvers={true: true, false: false}], [ strict=true ] )_:_
Promise<boolean|unknown>

`js
import { number_ } from 'oftypes'

const variable = 10
const resolvers = { true: 'it is a number!', false: 'it is not a number' }

console.log( await number_( variable, resolvers ) )

// prints it is a number!
`

`js
import { number_ } from 'oftypes'

const variable = '10'
const resolvers = { true: 'it is a number!', false: 'it is not a number' }

console.log( await string_( variable, resolvers ) )

// prints it is a number!
`

disabling strict mode.

`js
import { number_ } from 'oftypes'

const variable = '10'
const resolvers = { true: 'it is a number!', false: 'it is not a number' }

console.log( await number_( variable, resolvers, false ) )

// prints it is a number!
`

`js
import { number_ } from 'oftypes'

const variable = 'folks'
const resolvers = { true: 'it is a number!', false: 'it is not a number' }

console.log( await number_( variable, resolvers ) )

// prints it is not a number!
`

___

$3

signature
object_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { object_ } from 'oftypes'

const variable = [ 'hello folks!' ]
const resolvers = { true: 'it is an object!', false: 'it is not an object!' }

console.log( await object_( variable, resolvers ) )

// prints it is not an object!
`

`js
import { object_ } from 'oftypes'

const variable = { array1: [ 'hello folks!' ] }
const resolvers = { true: 'it is an object!', false: 'it is not an object!' }

console.log( await object_( variable, resolvers ) )

// prints it is an object!
`

___

$3

signature
promise_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { promise_ } from 'oftypes'

const variable = new Promise( resolve => resolve( 'promise' ) )
console.log( await promise_( variable ) )

// prints true

`

___

$3

signature
set_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { set_ } from 'oftypes'

console.log( await set_( new Map() ) )

// prints false
`

`js
import { set_ } from 'oftypes'

console.log( await set_( new Set() ) )

// prints true
`

___

$3

signature
string_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { string_ } from 'oftypes'

const variable = 'hello folks!'
const resolvers = { true: 'it is a string!', false: 'it is not a string' }

console.log( await string_( variable, resolvers ) )

// prints it is a string!
`

`js
import { string_ } from 'oftypes'

const variable = ['hello folks!']

console.log( await string_( variable ) )


// prints false
`

___

$3

signature
symbol_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { symbol_ } from 'oftypes'

const variable = Symbol( 'symbol_' )

console.log( await symbol_( variable ) )
// prints true
`

`js
import { symbol_ } from 'oftypes'

const variable = Array(26)

console.log( await symbol_( variable ) )
// prints false
`

___

$3

signature
undefined_( variable: any, [ resolvers={true: true, false: false}] )_:_
Promise<boolean|unknown>

`js
import { undefined_ } from 'oftypes'

console.log( await undefined_( undefined ) )

// prints true

`

`js
import { undefined_ } from 'oftypes'

console.log( await undefined_( null ) )

// prints false

`

___

Not Oftypes Functions

___

$3

signature
oftype_( variable: any, [ resolver=Map], [execute_callback={type:'async|sync|promise'}] )_:_
Promise<string|unknown>

>it rejects if the resolver argument is undefined and the argument execute_callback is set.

- simple usage.
`javascript
import { oftype_ } from 'oftypes'

console.log( await oftype_( 10 ) )

// prints -> Number
`

- using resolver argument.

`js
import { oftype_ } from 'oftypes'

const resolver = new Map();
resolver.set( 'Array', 'it is an Array' );

console.log( await oftype_( [ 1, 3, 5 ], resolver ) )

// prints -> it is an Array
`

- it returns false if the resolver mismatches with the actual type of the variable.

`js
import { oftype_ } from 'oftypes'

const variable = async ()=>{} /AsyncFunction/
const resolver = new Map();
resolver.set( 'Symbol', 'it is Symbol' );

console.log( await oftype_( variable, resolver ) )

// prints -> false
`

- it executes the callback function depending on the type given to the execute_callback property type.

`js
import { oftype_ } from 'oftypes'

const variable = Symbol( 'symbol' )
const fn_callback = () => { console.log( type ) }
const resolver = new Map();
resolver.set( 'Symbol', fn_callback );

await oftype_( variable, resolver, {type:'sync'} )

// prints -> Symbol given
`

___

$3

signature

resolvers(truthy: any, falsy: any, [ execute_callback={truthy: 'async|sync|promise', falsy: 'async|sync|promise'}] ):
Promise<uknown>

execute_callback argument will execute the given function (given to truthy&falsy arguments) depending on the type of the truthy and falsy properties. leave it undefined to return the resolver data.

`js
// import the resolvers function.
import { boolean_, resolvers } from 'oftypes'

// usually the resolvers are set like this, and in case we are resolving many oftypes.[functions]
// we will need to declare many unique const/let variables with unique name.

const resolvers_as_object = { true: 'true', false: 'false' }
const boolean = 'string'

// instead of passing the argument as an object -> resolvers_as_object
// we directly pass the resolvers function with the two arguments set to 'true' and 'false' respectively
// the resolvers function will return the same things as the resolvers_as_object would do.

console.log( await boolean_( boolean, await resolvers( 'true', 'false' ) ) )

// prints 'false'

``

___

JetBrains OSS License

___

I want to thank JetBrains to grant me the Open Source Software licence for all their products. This opportunity gives me strength to keep on going with my studies and personal project.
To learn more about this opportunity, have a look at Licences for Open Source Development - Community Support.

_Thank you_

___

Contacts

- twitter
- open-collective

___