Skip to content
This repository has been archived by the owner on Oct 10, 2018. It is now read-only.

Latest commit

 

History

History
200 lines (112 loc) · 6.27 KB

CHANGELOG.md

File metadata and controls

200 lines (112 loc) · 6.27 KB
Raw

7.5.0

New Features

7.4.1

Bug Fixes

  • Adding the LICENCE file back to the repo directly rather than a symbolic link.

7.4.0

New Features

  • Adding VERSION variable to main export.

Internal Changes

  • Now using more sophisticated build system with webpack and karma.
  • Renamed files in src directory to use dashes rather than camelCase.

7.3.0

New Features

  • Adding args to the result of apiCheck instance function (#25).

Bug Fixes

  • If you passed null as one of the arguments, api-check would try to call Object.keys(null) when generating the message. (#24)

7.2.4

Bug Fixes

  • Removing source-maps entirely for the unminified build...

7.2.3

  • Removing sourcemaps from the dist file because it's not removed during minification.
  • Renamed repo to api-check

7.2.2

  • Fixing bug with displaying function instead of shortType.

7.2.1

  • Improving messaging for types that take a checker as part of the checker

7.2.0

  • Adding .optional to .nullable so you can do apiCheck.string.nullable.optional
  • Adding .all to shape.requiredIfNot so you can do apiCheck.shape.requiredIfNot(['foo', 'bar'], apiCheck.string)

7.1.0

  • Adding originalChecker property to the checker that's returned from getRequiredVersion for debugging (#13)
  • Added null checker (#16)
  • Added nullable to all checkers and to setupChecker (#16)
  • Added range checker (#16)
  • Added shape.requiredIfNot checker

7.0.0

  • Official release!

7.0.0-beta.4

  • Now, all instances of apiCheck get their very own copies of checkers. If the instance of apiCheck is set to disabled, then any checkers created will be initialized as no-op functions to improve performance when doing checking.

7.0.0-beta.3

  • Fixing issue where types were specifying [Circular] when it wasn't actually circular...

7.0.0-beta.2

  • Fixing bug with calling Object.keys on a non-object

7.0.0-beta.1

  • Adding json-stringify-safe to do safe stringifying of data.

7.0.0-beta.0

  • Changing the api for disabled. No longer two functions, now just a value you set. You can also initialize it with a disabled property.
  • Adding globalConfig to allow you to disable all instances of apiCheck and to enable you to set everything to verbose.
  • Changed the name of the dist files to be api-check.js and api-check.min.js (used to be apiCheck.js and apiCheck.min.js)
  • Improved messages

6.0.11

  • Fixing bower.json case issue

6.0.10

  • Making output of user's arguments easier to read by replacing null with the function name.

6.0.9

  • Fixing bug with optional arguments.

6.0.8

  • Fixing bug when specifying custom functions that don't have a type property.

6.0.7

  • Removing .idea folder from npm and bower. (－‸ლ)

6.0.6

  • Adding passed, failed, and message to what is returned when apiCheck passes (or when it's disabled).
  • Loosening the api to apiCheck. You now can pass an array instead of an arguments-like object. It's much easier to deal with if you're not actually passing arguments.

6.0.5

  • Fixing bug where optional arguments were being tested against the wrong checkers.

6.0.4

  • Fixing bug with onlyIf when getting the type for a shape.

6.0.3

  • Adding .npmignore
  • correctly returning what should be returned when it's disabled

6.0.2

  • Adding utils to the main export.

6.0.1

  • Somehow I forgot to run the build for 6.0.0

6.0.0

  • You must now create an instance of apiCheck by invoking apiCheck. This allows multiple instances on a single page so many libraries can use their own instance and not conflict with the application's instance. Specifically useful for the global config options. (#7)

5.0.0

  • Adding extra output options to override the global ones on a per call basis.
  • Changing output.url to output.urlSuffix in favor of output.url overriding the rest of the url
  • Fixing bug with ending optional arguments

4.0.1

  • Forgot to give the same love to shape.strict that I gave to shape.
  • Relaxing the requirements of a type checker

4.0.0

  • Fixing the way the enums shortType looks.
  • Adding child checker to func called withProperties which is basically just a shape on a function.
  • Making an adjustment to how location works in shape. This makes it more readable.
  • Adding the ability to specify a help property string/function(val) on custom checkers. This (or the result of the invoked function) will be appended to the error message.
  • Adding more strict type checking for custom checkers.
  • Adding the ability to specify whether you want shape to check if it's an object first (pass true as the second parameter, and it will not check whether it's an object first).
  • Adding apiCheck.config.verbose.
  • type checkers can now control how much data they output based on whether apiCheck.config.verbose is true or not. If they specify their type as a function, that will be invoked and what is returned is used for the type for display. (#5)
  • shape taking advantage of the new .type function api to show where exactly in the object the error occurred and whether it was a result of a missing field that was required or a field that failed type validation.

3.0.4

  • Fixing oneOfType's type

3.0.3

  • Bug fix. The argTypes should be an object, not stringified (#3)

3.0.2

  • Missed a console.log :-/ Should probably put in a checker for that...

3.0.1

  • Quick breaking change, hopefully nobody will be impacted because it was literally minutes. Now returning an object instead of just a string message. This make things much more flexible.

3.0.0

  • Seriously improved how the messages are formatted. There's a lot more there, but it's awesome.

2.0.1

  • Returning the message from apiCheck.warn/throw. Though, if an error is actually thrown, then any responding code to the returned message will not run...

2.0.0

  • Major internal api changes. All checkers now return an error like React's propTypes and the messaging has been improved.

1.0.1

  • Updating readme

1.0.0

  • Initial release. Enjoy :-)