Skip to content

add typescript definitions #25

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

add typescript definitions #25

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ea9a873
(deps): update package-lock.json
agilgur5 May 29, 2019
ae9fa04
add @types/react by itself - fixup w/ 1st commit to PR
agilgur5 May 29, 2019
f2536de
add typescript definitions
chillitom Nov 5, 2018
060fe9b
fix imports and make extra props optional
chillitom Nov 5, 2018
a2fae62
(format/types): use standard style for types
agilgur5 May 29, 2019
61e4c2f
(types): canvasProps should be more specific than any
agilgur5 May 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.0.1",
"description": "A signature pad implementation in React",
"main": "build/index.js",
"types": "src/index.d.ts",
"types": "src/index.d.ts",
"scripts": {
"test": "webpack && npm pack",
"start": "webpack-dev-server -d --inline --hot",
Expand Down
7 changes: 5 additions & 2 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@

import * as React from 'react';

// signature_pad's props
// (taken from https://github.com/szimek/signature_pad/blob/e2af461bca7ceb7cc5afb8349930908ca19f2f56/src/signature_pad.ts#L23)
Copy link
Owner

@agilgur5 agilgur5 May 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we import signature_pad's types directly from signature_pad? I haven't updated to the beta yet (as it's beta) so that might not be possible until then and this might be fine in the meantime

export interface IOptions {
Copy link
Owner

@agilgur5 agilgur5 May 29, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be IOptions? or SignaturePadOptions? should it be (re-)exported?

Expand All @@ -15,8 +18,8 @@ export interface IOptions {

// props specific to the React wrapper
export interface SignatureCanvasProps extends IOptions {
canvasProps: any;
clearOnResize: boolean;
canvasProps?: any;
clearOnResize?: boolean;
}

export default class SignatureCanvas extends React.Component<SignatureCanvasProps> {}