Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting Started Documentation - config import #324

Closed
cindyyu opened this issue Jun 11, 2019 · 1 comment · Fixed by #358
Closed

Getting Started Documentation - config import #324

cindyyu opened this issue Jun 11, 2019 · 1 comment · Fixed by #358

Comments

@cindyyu
Copy link

cindyyu commented Jun 11, 2019

In the Getting Started part of the documentation, it says to use

import config from '@redux-offline/redux-offline/lib/config';

I get Typescript errors when I use this import, but when I use the import suggested in the entry level Readme

import offlineConfig from '@redux-offline/redux-offline/lib/defaults';

It works fine for me. I think it'd be helpful to make the two pieces of documentation consistent (they both seem like getting started guides) or if there is a difference between config and defaultConfig, clarify the difference. I poked around very briefly and did not see lib/config defined in the typings.d.ts file.

Are you using offline() or createOffline() API?

n/a

Store config

n/a

Offline config

n/a

Are you reporting a bug?

No.

@calumpeak
Copy link
Member

Thanks for the heads-up. Would you be able to raise a PR for this, please?

adhyapranata added a commit to adhyapranata/redux-offline that referenced this issue Sep 25, 2019
calumpeak added a commit that referenced this issue Sep 30, 2019
Update config import in getting started documentation - resolves #324
sorodrigo pushed a commit that referenced this issue May 11, 2020
 into expo

* 'develop' of https://github.com/redux-offline/redux-offline:
  let's rename the function as well
  Fixed args in example for REGISTER_USER action
  Update README.md
  Create empty-outbox.md
  Update config import in getting started documentation - resolves #324
  Update npm tag from native.0 to native
  use rm -rf on lib before build
  Update readme for RN 0.60+
sorodrigo pushed a commit that referenced this issue May 11, 2020
 into native

* 'develop' of https://github.com/redux-offline/redux-offline:
  let's rename the function as well
  Fixed args in example for REGISTER_USER action
  Update README.md
  Create empty-outbox.md
  Update config import in getting started documentation - resolves #324
  Update npm tag from native.0 to native
  use rm -rf on lib before build
  Update readme for RN 0.60+
sorodrigo pushed a commit that referenced this issue May 21, 2020
* develop: (28 commits)
  2.6.0
  fix test
  adds tests for multipart/form-data repackaging
  Fix for eslint test
  fix for sending FormData after restart the app
  runs flow on commit hook
  updates pkg.lock in examples
  update example app
  updates git hooks
  bumps all dependencies
  add expo version to readme
  let's rename the function as well
  Fixed args in example for REGISTER_USER action
  Update README.md
  Create empty-outbox.md
  Update config import in getting started documentation - resolves #324
  Update npm tag from native.0 to native
  use rm -rf on lib before build
  Update readme for RN 0.60+
  2.5.2
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants