koa-shopify-auth icon indicating copy to clipboard operation
koa-shopify-auth copied to clipboard

Why isn't createShopifyAuth documented in README.md?

Open RavenHursT opened this issue 2 years ago • 2 comments

Issue summary

Write a short description of the issue here ↓

This is more of a "question" than a "bug", but it seems GH Discussions aren't enabled on this repo, and the issue creation flow have an option to ask a question, so I'm doing it this way. I hope that's ok 😬

I see instructions for how to use shopifyAuth middleware. But most of the examples I've seen across the interwebs, plus the app that I've inherited, that I'm currently working on, are using createShopifyAuth: https://github.com/Shopify/koa-shopify-auth/blob/master/src/auth/index.ts#L33

I keep having to jump to that source code just to know how it behaves, what args I should send it, etc.

Expected behavior

What do you think should happen?

Would be nice to have this area properly documented, w/ some kind of explanation of the diff between shopifyAuth and createShopifyAuth

Actual behavior

What actually happens?

Have to read and interpret source code to use createShopifyAuth

RavenHursT avatar Mar 03 '22 21:03 RavenHursT

Would be helpful as well since our app was built with createShopifyAuth too, and since updating to 5.0.3 have been facing issues

technologytesting avatar Mar 08 '22 15:03 technologytesting

Consolidating documentation could simplify development and make life easier. But in this case, may it doesn't matter how you call the default import function from koa-shopify-auth. Every name points to the default export from the library.

Draccano avatar Apr 19 '22 13:04 Draccano

Note that this repo is no longer maintained and this issue will not be reviewed. Prefer the official JavaScript API library. If you still want to use Koa, see simple-koa-shopify-auth for a potential community solution.

github-actions[bot] avatar Jan 30 '23 20:01 github-actions[bot]