Skip to content

Add typescript definition file #8

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

Merged
merged 6 commits into from
Aug 23, 2019
Merged

Add typescript definition file #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d02d369
add typescript definition file
koddsson Jul 29, 2019
fa7c3ae
use long form of a optional type
koddsson Jul 30, 2019
4f07da1
`SimpleRequest.body` cannot be `undefined`
koddsson Aug 19, 2019
9e361d2
statusText is not nullable
koddsson Aug 19, 2019
9346927
Merge branch 'master' of github.com:github/remote-form into add-types…
koddsson Aug 19, 2019
a28805d
change callback return types to `void` from `mixed`
koddsson Aug 20, 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
28 changes: 28 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
type Kicker = {
text: () => Promise<SimpleResponse>,
json: () => Promise<SimpleResponse>,
html: () => Promise<SimpleResponse>
}

type SimpleRequest = {
method: string,
url: string,
body: FormData | null,
headers: Headers
}

export type SimpleResponse = {
url: string,
status: number,
statusText: string,
headers: Headers,
text: string,
json: {[key: string]: any},
html: DocumentFragment
}

export type RemoteFormHandler = (form: HTMLFormElement, kicker: Kicker, req: SimpleRequest) => void | Promise<void>;
export function afterRemote(fn: (form: HTMLFormElement) => void): void;
export function beforeRemote(fn: (form: HTMLFormElement) => void): void;
export function remoteForm(selector: string, fn: RemoteFormHandler): void;
export function remoteUninstall(selector: string, fn: RemoteFormHandler): void;
4 changes: 3 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@
"description": "Decorator that will submit a form over AJAX",
"repository": "github/remote-form",
"files": [
"dist"
"dist",
"index.d.ts"
],
"main": "dist/index.umd.js",
"module": "dist/index.esm.js",
"types:": "index.d.ts",
"scripts": {
"clean": "rm -rf dist",
"lint": "github-lint",
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ type SimpleRequest = {
export type SimpleResponse = {
url: string,
status: number,
statusText: ?string,
statusText: string,
headers: Headers,
text: string,
// eslint-disable-next-line flowtype/no-weak-types
Expand Down
6 changes: 3 additions & 3 deletions src/index.js.flow
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ type SimpleRequest = {
export type SimpleResponse = {
url: string,
status: number,
statusText: ?string,
statusText: string,
headers: Headers,
text: string,
json: {[string]: any},
html: DocumentFragment
}
export type RemoteFormHandler = (form: HTMLFormElement, kicker: Kicker, req: SimpleRequest) => void | Promise<void>;

declare export function afterRemote(fn: (form: HTMLFormElement) => mixed): void;
declare export function beforeRemote(fn: (form: HTMLFormElement) => mixed): void;
declare export function afterRemote(fn: (form: HTMLFormElement) => void): void;
declare export function beforeRemote(fn: (form: HTMLFormElement) => void): void;
declare export function remoteForm(selector: string, fn: RemoteFormHandler): void;
declare export function remoteUninstall(selector: string, fn: RemoteFormHandler): void;