Skip to content
This repository has been archived by the owner on May 15, 2021. It is now read-only.

Example has misleading types in responseData. (typo in documentation) #19

Closed
mbejda opened this issue Nov 5, 2018 · 1 comment
Closed

Comments

@mbejda
Copy link

mbejda commented Nov 5, 2018

Typo in documentation

Documentation implies the responseData type action is string which is incorrect. It should be
type Action.

Error thrown by the IDE because of incorrect type.
https://github.com/hellobloom/share-kit/blame/master/README.md#L94
screen shot 2018-11-05 at 1 24 31 pm

The example should include the correct type like so:

 
      const requestData: RequestData = {
      action: <Action>'request_attestation_data',
      token: "0x8f31e48a585fd12ba58e70e03292cac712cbae39bc7eb980ec189aa88e24d04",
      url: "https://bloom.co/api/receiveData",
      org_logo_url: 'https://bloom.co/images/notif/bloom-logo.png',
      org_name: 'Bloom',
      org_usage_policy_url: 'https://bloom.co/legal/terms',
      org_privacy_policy_url: 'https://bloom.co/legal/privacy',
      types: ['full-name', 'phone', 'email'],
    }
@JaceHensley
Copy link
Contributor

fix in #20

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants