make notSetValue parameter optional in typings #214
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## v1.5.0 #214 +/- ##
=========================================
Coverage ? 89.56%
=========================================
Files ? 17
Lines ? 1638
Branches ? 265
=========================================
Hits ? 1467
Misses ? 171
Partials ? 0 |
prescottprue
added a commit
that referenced
this pull request
Jul 30, 2017
* Fix race condition with `uniqueSet` - #207 * Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * Typescript Typings updated make `notSetValue` not required (i.e. `dataToJS(firebase, 'todos')` instead of `dataToJS(firebase, 'todos', undefined)`) - #214
|
v1.5.0-rc.3 includes this fix |
Merged
prescottprue
added a commit
that referenced
this pull request
Sep 18, 2017
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 ### Breaking Changes * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 ### Core * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 ### Build * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance ### Docs * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
prescottprue
added a commit
that referenced
this pull request
Sep 18, 2017
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
prescottprue
added a commit
that referenced
this pull request
Sep 18, 2017
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
prescottprue
added a commit
that referenced
this pull request
Sep 18, 2017
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
prescottprue
added a commit
that referenced
this pull request
Sep 18, 2017
🍾 🥂 The long awaited v1.5.0 release 🥂 🍾 * `browser` field has been removed from `package.json` which means commonJS build is used instead of `UMD` build from Webpack (much smaller) * [firebaseConnect] Uses `prop-types` instead of importing from React - #122 * [firebaseConnect] Allow usage of different stores in `firebaseConnect` - #148, #29 * [firebaseConnect] statics are now hoisted thanks to `hoist-non-react-statics` * [firebaseConnect] exposed `createFirebaseConnect` for creating `firebaseConnect` HOCs connected to different stores * [auth] `login` method supports `credential` parameter (with matching docs and tests updates) * [auth] deprecation warning added for `token` and `provider` combo in `login` method * [auth] Adds `updateProfile`, `updateAuth`, and `updateEmail` methods that dispatch associated start/success/failure actions * [helpers] `deleteFile` method response no longer includes `dbPath` if it is undefined (test added to check this case) * [helpers] No more race condition with `uniqueSet` - #207 * [typescript] Typescript typings - #142, #214 * [query] `watchEvent` accepts options object as third argument * [populate] Lodash path syntax support - #132 * [populate] accept a function for populate for item based populate config - #132 * [populate] Profile population (`profileParamsToPopulate`) supports single item and list population - #203 * [storage] `uploadFile` and `uploadFiles` no longer track progress by default (`storageRef.put` called directly) * [config] Usage of `profileFactory` is wrapped in try/catch to handle and reject errors within provided factory function * [config] `distpatchOnUnsetListener` spelling fixed to be `dispatchOnUnsetListener` (depreciation warning added along with a test confirm it is displayed) * [config] `enableEmptyAuthChanges` config option added - #137 * Firebase is now an external in Webpack config (shrinks UMD build size) * `.npmignore` expanded to include more files that do not needed to be included in published version (including `.babelrc` which can cause build errors) * `.babelrc` settings are now environment specific (decorators only used in testing) * `babel-preset-stage-1` removed (unnecessary) * `.eslintrc` added to tests folder which contains globals that are only necessary for testing (simplifies top level eslint config) * `.eslintrc` file now using yaml format instead of JSON format (easier to read) * `async/await` added to unit tests * Webpack 2 * [`firebase-server`](https://github.com/urish/firebase-server) used in tests instead of connecting to a real Firebase instance * Query docs updated with `storeAs` and `keyProp` query options * `redux-persist` recipe added
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR modifies the typings and makes the fallback-value (
notSetValue) optional in all methods. This makes it possible to use it with two parameters and the implicit fallback-value ofundefined, e.g.dataToJS(firebase, 'todos')instead ofdataToJS(firebase, 'todos', undefined).The docs don't have to be changed as this usage is intended and already possible in plain JS. The example above is copied from the docs.
Because this API-change is backwards compatible, no major release is necessary. I recommend to include this into the upcoming
1.5.0release.Check List