Skip to content
This repository was archived by the owner on Jul 14, 2022. It is now read-only.
This repository was archived by the owner on Jul 14, 2022. It is now read-only.

Main documentation does not match current release #102

@byteofsilicon

Description

@byteofsilicon

Hey guys, just thought I'd give you a heads up that the current documentation on the homepage of this repo does not match the lastest NPM release.

I noticed this as I was attempting to write a custom strategy. The documentation on the homepage indicates that a strategy must implement the following interface:

class Strategy {
    // shop refers to the shop's domain name
    getShop({ shop }): Promise<{accessToken: string}>
    // shop refers to the shop's domain name
    storeShop({ shop, accessToken }): Promise<{accessToken: string}>
}

However, after looking into the NPM package https://registry.npmjs.org/@shopify/shopify-express/-/shopify-express-1.0.0-alpha.7.tgz it looks as though the actual interface is still using callbacks:

class Strategy {
    // shop refers to the shop's domain name
    getShop({ shop }, (err, accessToken) => void)
    // shop refers to the shop's domain name
    storeShop({ shop, accessToken }, (err, accessToken) => void)
}

Is there any plan to publish a new release? Or perhaps it is an error on my end? Any assistance would be much appreciated. Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions