Giter Club home page Giter Club logo

Comments (8)

balupton avatar balupton commented on May 15, 2024

Modifying typeMap directly would also change functionality for other packages that use typechecker which could cause problems.

However, getType accepts a second parameter that can be a type map, so you could do the following:

// custom-typechecker.js
const typechecker = require('typechecker')
const customTypeChecker = Object.assign({}, typechecker)

const customTypeMap = {
	array: typechecker.isArray,
	boolean: typechecker.isBoolean,
	date: typechecker.isDate,
	error: typechecker.isError,
	class: typechecker.isClass,
	function: typechecker.isFunction,
	null: typechecker.isNull,
	number: typechecker.isNumber,
	regexp: typechecker.isRegExp,
	string: typechecker.isString,
	'undefined': typechecker.isUndefined,
	buffer: Buffer.isBuffer,  // must be before isObject, as otherwise isObject will catch it
	map: typechecker.isMap,
	weakmap: typechecker.isWeakMap,
	object: typechecker.isObject
}

customTypeChecker.getType = function customGetType (value, _typeMap) {
	return typechecker.getType(value, _typeMap || customTypeMap)
}

module.exports = customTypeChecker
// app.js
var result = require('./custom-typechecker.js').getType(Buffer.from(''))
console.log(result)  // buffer

from typechecker.

dkebler avatar dkebler commented on May 15, 2024

That didn't work as written. customTypeMap is neither exported nor passed into the new getType. I tried a few variations on this to no avail.

Did you mean this??
customTypeChecker.typeMap = {
would just overwrite the frozen type map and then nothing need be done to getTypes.

I tried that and that still fails. Got time to get this working for yourself first? I'll write a pr for the readme once it's working.


  it('Should include custom types', function () {
    expect(u.isBuffer(Buffer.from('this is a test'))).to.equal(true)
    expect(u.getType(Buffer.from('this is a test'))).to.equal('buffer')
  })

  1) Variable Types Library -  Should include custom types:

      AssertionError: expected 'object' to equal 'buffer'
      + expected - actual

      -object
      +buffer

from typechecker.

balupton avatar balupton commented on May 15, 2024

Update previous example, should work.

from typechecker.

balupton avatar balupton commented on May 15, 2024

@dkebler okay, my updated code should work, but there is a bug in typechecker, so I'll update the code

from typechecker.

balupton avatar balupton commented on May 15, 2024

@dkebler okay, v4.4.1 is fixed, which makes the above work

from typechecker.

balupton avatar balupton commented on May 15, 2024

the customTypeMap definition could also be done like so:

// Add our custom types
const customTypeMap = {
	buffer: Buffer.isBuffer
}
// Add original types
Object.keys(typechecker.typeMap).forEach(function (key) {
	customTypeMap[key] = customTypeMap[key] || typechecker.typeMap[key]
})

from typechecker.

dkebler avatar dkebler commented on May 15, 2024

@balupton thanks! Now I can all add my classes as types :-).

I definitely preferred merging the maps (cleaner) but your object.keys statement above wasn't doing it. So here is the final working module. I'll do a PR for the readme and add this with some explanation.
again thx.

//mytypechecker.js

const typechecker = require('typechecker')
const customTypeChecker = Object.assign({}, typechecker)

// add custom types, a key and corresponding function for each
customTypeChecker.isBuffer = function isBuffer(obj) {
  return !!obj.constructor && typeof obj.constructor.isBuffer === 'function' && obj.constructor.isBuffer(obj)
}

// Create a custom type map and make an key/property for each new type 
// the key/property used will be the string returned by getType. 
let customTypeMap = {
  buffer: customTypeChecker.isBuffer
}

// merge base typeMap with customTypeMap
customTypeMap = Object.assign(customTypeMap, customTypeChecker.typeMap)

//overwrite getType to use customTypeMap if available
customTypeChecker.getType = function customGetType(value, _typeMap) {
  return typechecker.getType(value, _typeMap || customTypeMap)
}

module.exports = customTypeChecker

from typechecker.

balupton avatar balupton commented on May 15, 2024

Glad it works :-)

I definitely preferred merging the maps (cleaner) but your object.keys statement above wasn't doing it.

Whoops fixed.

from typechecker.

Related Issues (18)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.