ntzwrk / blockstack.ts

work in progress, please check back later
MIT License
10 stars 1 forks source link

Types for custom-protocol-detection-blockstack #5

Open vsund opened 6 years ago

vsund commented 6 years ago

@larry, currently looking into custom-protocol-detection-blockstack and writing a type declaration for it, but wondering where it gets its name from (the name is still custom-protocol-detection in your fork).

Have written a (really) basic declaration

/**
 * Checks whether a given protocol handler exists and performs corresponding actions
 * 
 * @param protocolURI Protocol URI to check for
 * @param failCallback Callback function to execute when the protocol handler doesn't existt
 * @param successCallback Callback function to execute when the protocol handler exists
 * @param unsupportedBrowserCallback Callback function to execute when found an unsupported browser
 */
export declare function protocolCheck(
    protocolURI: string, failCallback: () => void, successCallback: () => void, unsupportedBrowserCallback: () => void
): void;

but getting problems when trying to yarn link my fork of your fork into my port (:sweat_smile:).

Am I missing something here? (Fixed it for now with manually symlinking my fork.)

Edit: Types are live in my fork at https://github.com/vsund/custom-protocol-detection/tree/feature/add-typescript-declarations (that's what I manually symlinked into the project).