Throw custom error when request was canceled
This commit is contained in:
AkiraFukushima
parent
db827bbd5a
commit
0e2a701b12
25
example/typescript/cancel.ts
Normal file
25
example/typescript/cancel.ts
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
import Mastodon, { Response, Results, isCancel } from 'megalodon'
|
||||
|
||||
const BASE_URL: string = 'https://pleroma.io'
|
||||
|
||||
const access_token: string = process.env.PLEROMA_ACCESS_TOKEN!
|
||||
|
||||
const client = new Mastodon(access_token, BASE_URL + '/api/v2')
|
||||
|
||||
client
|
||||
.get<Results>('/search', {
|
||||
q: 'whalebird',
|
||||
resolve: true
|
||||
})
|
||||
.then((resp: Response<Results>) => {
|
||||
console.log(resp.data.hashtags)
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
if (isCancel(err)) {
|
||||
console.log('Request was canceled')
|
||||
}
|
||||
})
|
||||
|
||||
setTimeout(() => {
|
||||
client.cancel()
|
||||
}, 5000)
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
"author": "h3poteto",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"typescript": "^2.9.2",
|
||||
"typescript": "^3.4.5",
|
||||
"megalodon": "file:../../"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,12 +4,8 @@ const BASE_URL: string = 'https://mastodon.social'
|
|||
|
||||
const access_token: string = '...'
|
||||
|
||||
const client = new Mastodon(
|
||||
access_token,
|
||||
BASE_URL + '/api/v1'
|
||||
)
|
||||
const client = new Mastodon(access_token, BASE_URL + '/api/v1')
|
||||
|
||||
client.get<[Status]>('/timelines/home')
|
||||
.then((resp: Response<[Status]>) => {
|
||||
console.log(resp.data)
|
||||
})
|
||||
client.get<Array<Status>>('/timelines/home').then((resp: Response<Array<Status>>) => {
|
||||
console.log(resp.data)
|
||||
})
|
||||
|
|
|
|||
|
|
@ -7,11 +7,6 @@
|
|||
resolved "https://registry.yarnpkg.com/@types/caseless/-/caseless-0.12.1.tgz#9794c69c8385d0192acc471a540d1f8e0d16218a"
|
||||
integrity sha512-FhlMa34NHp9K5MY1Uz8yb+ZvuX0pnvn3jScRSNAb75KHGB8d3rEU6hqMs3Z2vjuytcMfRg6c5CHMc3wtYyD2/A==
|
||||
|
||||
"@types/events@*":
|
||||
version "1.2.0"
|
||||
resolved "https://registry.yarnpkg.com/@types/events/-/events-1.2.0.tgz#81a6731ce4df43619e5c8c945383b3e62a89ea86"
|
||||
integrity sha512-KEIlhXnIutzKwRbQkGWb/I4HFqBuUykAdHgDED6xqwXJfONCjF5VoE0cXEiurh3XauygxzeDzgtXUqvLkxFzzA==
|
||||
|
||||
"@types/form-data@*":
|
||||
version "2.2.1"
|
||||
resolved "https://registry.yarnpkg.com/@types/form-data/-/form-data-2.2.1.tgz#ee2b3b8eaa11c0938289953606b745b738c54b1e"
|
||||
|
|
@ -46,12 +41,11 @@
|
|||
resolved "https://registry.yarnpkg.com/@types/tough-cookie/-/tough-cookie-2.3.3.tgz#7f226d67d654ec9070e755f46daebf014628e9d9"
|
||||
integrity sha512-MDQLxNFRLasqS4UlkWMSACMKeSm1x4Q3TxzUC7KQUsh6RK1ZrQ0VEyE3yzXcBu+K8ejVj4wuX32eUG02yNp+YQ==
|
||||
|
||||
"@types/websocket@0.0.40":
|
||||
version "0.0.40"
|
||||
resolved "https://registry.yarnpkg.com/@types/websocket/-/websocket-0.0.40.tgz#887cd632a8b3d0d11da7b9d0d106af85997b358c"
|
||||
integrity sha512-ldteZwWIgl9cOy7FyvYn+39Ah4+PfpVE72eYKw75iy2L0zTbhbcwvzeJ5IOu6DQP93bjfXq0NGHY6FYtmYoqFQ==
|
||||
"@types/ws@^6.0.1":
|
||||
version "6.0.2"
|
||||
resolved "https://registry.yarnpkg.com/@types/ws/-/ws-6.0.2.tgz#f3340f7e3d7a07104a5dbcaa8ada4e8d2d45eecb"
|
||||
integrity sha512-22XiR1ox9LftTaAtn/c5JCninwc7moaqbkJfaDUb7PkaUitcf5vbTZHdq9dxSMviCm9C3W85rzB8e6yNR70apQ==
|
||||
dependencies:
|
||||
"@types/events" "*"
|
||||
"@types/node" "*"
|
||||
|
||||
ajv@^5.3.0:
|
||||
|
|
@ -76,6 +70,11 @@ assert-plus@1.0.0, assert-plus@^1.0.0:
|
|||
resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525"
|
||||
integrity sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=
|
||||
|
||||
async-limiter@^1.0.0:
|
||||
version "1.0.1"
|
||||
resolved "https://registry.yarnpkg.com/async-limiter/-/async-limiter-1.0.1.tgz#dd379e94f0db8310b08291f9d64c3209766617fd"
|
||||
integrity sha512-csOlWGAcRFJaI6m+F2WKdnMKr4HhdhFVBk0H/QbJFMCr+uO2kwohwXQPxw/9OCxp05r5ghVBFSyioixx3gfkNQ==
|
||||
|
||||
asynckit@^0.4.0:
|
||||
version "0.4.0"
|
||||
resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79"
|
||||
|
|
@ -91,13 +90,13 @@ aws4@^1.8.0:
|
|||
resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.8.0.tgz#f0e003d9ca9e7f59c7a508945d7b2ef9a04a542f"
|
||||
integrity sha512-ReZxvNHIOv88FlT7rxcXIIC0fPt4KZqZbOlivyWtXLt8ESx84zd3kMC6iK5jVeS2qt+g7ftS7ye4fi06X5rtRQ==
|
||||
|
||||
axios@^0.18.0:
|
||||
version "0.18.0"
|
||||
resolved "https://registry.yarnpkg.com/axios/-/axios-0.18.0.tgz#32d53e4851efdc0a11993b6cd000789d70c05102"
|
||||
integrity sha1-MtU+SFHv3AoRmTts0AB4nXDAUQI=
|
||||
axios@^0.18.1:
|
||||
version "0.18.1"
|
||||
resolved "https://registry.yarnpkg.com/axios/-/axios-0.18.1.tgz#ff3f0de2e7b5d180e757ad98000f1081b87bcea3"
|
||||
integrity sha512-0BfJq4NSfQXd+SkFdrvFbG7addhYSBA2mQwISr46pD6E5iqkWg02RAs8vyTT/j0RTnoYmeXauBuSv1qKwR179g==
|
||||
dependencies:
|
||||
follow-redirects "^1.3.0"
|
||||
is-buffer "^1.1.5"
|
||||
follow-redirects "1.5.10"
|
||||
is-buffer "^2.0.2"
|
||||
|
||||
bcrypt-pbkdf@^1.0.0:
|
||||
version "1.0.2"
|
||||
|
|
@ -149,13 +148,6 @@ debug@=3.1.0:
|
|||
dependencies:
|
||||
ms "2.0.0"
|
||||
|
||||
debug@^2.2.0:
|
||||
version "2.6.9"
|
||||
resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f"
|
||||
integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==
|
||||
dependencies:
|
||||
ms "2.0.0"
|
||||
|
||||
delayed-stream@~1.0.0:
|
||||
version "1.0.0"
|
||||
resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619"
|
||||
|
|
@ -194,10 +186,10 @@ fast-json-stable-stringify@^2.0.0:
|
|||
resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.0.0.tgz#d5142c0caee6b1189f87d3a76111064f86c8bbf2"
|
||||
integrity sha1-1RQsDK7msRifh9OnYREGT4bIu/I=
|
||||
|
||||
follow-redirects@^1.3.0:
|
||||
version "1.5.8"
|
||||
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.5.8.tgz#1dbfe13e45ad969f813e86c00e5296f525c885a1"
|
||||
integrity sha512-sy1mXPmv7kLAMKW/8XofG7o9T+6gAjzdZK4AJF6ryqQYUa/hnzgiypoeUecZ53x7XiqKNEpNqLtS97MshW2nxg==
|
||||
follow-redirects@1.5.10:
|
||||
version "1.5.10"
|
||||
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.5.10.tgz#7b7a9f9aea2fdff36786a94ff643ed07f4ff5e2a"
|
||||
integrity sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==
|
||||
dependencies:
|
||||
debug "=3.1.0"
|
||||
|
||||
|
|
@ -244,12 +236,12 @@ http-signature@~1.2.0:
|
|||
jsprim "^1.2.2"
|
||||
sshpk "^1.7.0"
|
||||
|
||||
is-buffer@^1.1.5:
|
||||
version "1.1.6"
|
||||
resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-1.1.6.tgz#efaa2ea9daa0d7ab2ea13a97b2b8ad51fefbe8be"
|
||||
integrity sha512-NcdALwpXkTm5Zvvbk7owOUSvVvBKDgKP5/ewfXEznmQFfs4ZRmanOeKBTjRVjka3QFoN6XJ+9F3USqfHqTaU5w==
|
||||
is-buffer@^2.0.2:
|
||||
version "2.0.3"
|
||||
resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-2.0.3.tgz#4ecf3fcf749cbd1e472689e109ac66261a25e725"
|
||||
integrity sha512-U15Q7MXTuZlrbymiz95PJpZxu8IlipAp4dtS3wOdgPXx3mqBnslrWU14kxfHB+Py/+2PVKSr37dMAgM2A4uArw==
|
||||
|
||||
is-typedarray@^1.0.0, is-typedarray@~1.0.0:
|
||||
is-typedarray@~1.0.0:
|
||||
version "1.0.0"
|
||||
resolved "https://registry.yarnpkg.com/is-typedarray/-/is-typedarray-1.0.0.tgz#e479c80858df0c1b11ddda6940f96011fcda4a9a"
|
||||
integrity sha1-5HnICFjfDBsR3dppQPlgEfzaSpo=
|
||||
|
|
@ -290,16 +282,16 @@ jsprim@^1.2.2:
|
|||
verror "1.10.0"
|
||||
|
||||
"megalodon@file:../..":
|
||||
version "0.3.1"
|
||||
version "0.8.2"
|
||||
dependencies:
|
||||
"@types/oauth" "^0.9.0"
|
||||
"@types/request" "^2.47.0"
|
||||
"@types/websocket" "0.0.40"
|
||||
axios "^0.18.0"
|
||||
"@types/ws" "^6.0.1"
|
||||
axios "^0.18.1"
|
||||
oauth "^0.9.15"
|
||||
request "^2.87.0"
|
||||
typescript "^2.9.1"
|
||||
websocket "^1.0.28"
|
||||
typescript "^3.4.5"
|
||||
ws "^7.0.1"
|
||||
|
||||
mime-db@~1.36.0:
|
||||
version "1.36.0"
|
||||
|
|
@ -318,11 +310,6 @@ ms@2.0.0:
|
|||
resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
|
||||
integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=
|
||||
|
||||
nan@^2.11.0:
|
||||
version "2.11.1"
|
||||
resolved "https://registry.yarnpkg.com/nan/-/nan-2.11.1.tgz#90e22bccb8ca57ea4cd37cc83d3819b52eea6766"
|
||||
integrity sha512-iji6k87OSXa0CcrLl9z+ZiYSuR2o+c0bGuNmXdrhTQTakxytAFsC56SArGYoiHlJlFoHSnvmhpceZJaXkVuOtA==
|
||||
|
||||
oauth-sign@~0.9.0:
|
||||
version "0.9.0"
|
||||
resolved "https://registry.yarnpkg.com/oauth-sign/-/oauth-sign-0.9.0.tgz#47a7b016baa68b5fa0ecf3dee08a85c679ac6455"
|
||||
|
|
@ -425,17 +412,10 @@ tweetnacl@^0.14.3, tweetnacl@~0.14.0:
|
|||
resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-0.14.5.tgz#5ae68177f192d4456269d108afa93ff8743f4f64"
|
||||
integrity sha1-WuaBd/GS1EViadEIr6k/+HQ/T2Q=
|
||||
|
||||
typedarray-to-buffer@^3.1.5:
|
||||
version "3.1.5"
|
||||
resolved "https://registry.yarnpkg.com/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz#a97ee7a9ff42691b9f783ff1bc5112fe3fca9080"
|
||||
integrity sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==
|
||||
dependencies:
|
||||
is-typedarray "^1.0.0"
|
||||
|
||||
typescript@^2.9.1, typescript@^2.9.2:
|
||||
version "2.9.2"
|
||||
resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.9.2.tgz#1cbf61d05d6b96269244eb6a3bce4bd914e0f00c"
|
||||
integrity sha512-Gr4p6nFNaoufRIY4NMdpQRNmgxVIGMs4Fcu/ujdYk3nAZqk7supzBE9idmvfZIlH/Cuj//dvi+019qEue9lV0w==
|
||||
typescript@^3.4.5:
|
||||
version "3.5.3"
|
||||
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.5.3.tgz#c830f657f93f1ea846819e929092f5fe5983e977"
|
||||
integrity sha512-ACzBtm/PhXBDId6a6sDJfroT2pOWt/oOnk4/dElG5G33ZL776N3Y6/6bKZJBFpd+b05F3Ct9qDjMeJmRWtE2/g==
|
||||
|
||||
uuid@^3.3.2:
|
||||
version "3.3.2"
|
||||
|
|
@ -451,17 +431,9 @@ verror@1.10.0:
|
|||
core-util-is "1.0.2"
|
||||
extsprintf "^1.2.0"
|
||||
|
||||
websocket@^1.0.28:
|
||||
version "1.0.28"
|
||||
resolved "https://registry.yarnpkg.com/websocket/-/websocket-1.0.28.tgz#9e5f6fdc8a3fe01d4422647ef93abdd8d45a78d3"
|
||||
integrity sha512-00y/20/80P7H4bCYkzuuvvfDvh+dgtXi5kzDf3UcZwN6boTYaKvsrtZ5lIYm1Gsg48siMErd9M4zjSYfYFHTrA==
|
||||
ws@^7.0.1:
|
||||
version "7.1.2"
|
||||
resolved "https://registry.yarnpkg.com/ws/-/ws-7.1.2.tgz#c672d1629de8bb27a9699eb599be47aeeedd8f73"
|
||||
integrity sha512-gftXq3XI81cJCgkUiAVixA0raD9IVmXqsylCrjRygw4+UOOGzPoxnQ6r/CnVL9i+mDncJo94tSkyrtuuQVBmrg==
|
||||
dependencies:
|
||||
debug "^2.2.0"
|
||||
nan "^2.11.0"
|
||||
typedarray-to-buffer "^3.1.5"
|
||||
yaeti "^0.0.6"
|
||||
|
||||
yaeti@^0.0.6:
|
||||
version "0.0.6"
|
||||
resolved "https://registry.yarnpkg.com/yaeti/-/yaeti-0.0.6.tgz#f26f484d72684cf42bedfb76970aa1608fbf9577"
|
||||
integrity sha1-8m9ITXJoTPQr7ft2lwqhYI+/lXc=
|
||||
async-limiter "^1.0.0"
|
||||
|
|
|
|||
13
src/cancel.ts
Normal file
13
src/cancel.ts
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
export class RequestCanceledError extends Error {
|
||||
public isCancel: boolean
|
||||
|
||||
constructor(msg: string) {
|
||||
super(msg)
|
||||
this.isCancel = true
|
||||
Object.setPrototypeOf(this, RequestCanceledError)
|
||||
}
|
||||
}
|
||||
|
||||
export const isCancel = (value: any): boolean => {
|
||||
return value && value.isCancel
|
||||
}
|
||||
|
|
@ -33,6 +33,7 @@ import { StatusParams } from './entities/status_params'
|
|||
import { Tag } from './entities/tag'
|
||||
import { Token } from './entities/token'
|
||||
import { URLs } from './entities/urls'
|
||||
import { isCancel, RequestCanceledError } from './cancel'
|
||||
|
||||
export {
|
||||
StreamListener,
|
||||
|
|
@ -40,6 +41,8 @@ export {
|
|||
Response,
|
||||
OAuth,
|
||||
MegalodonInstance,
|
||||
RequestCanceledError,
|
||||
isCancel,
|
||||
/**
|
||||
* Entities
|
||||
*/
|
||||
|
|
@ -69,7 +72,7 @@ export {
|
|||
StatusParams,
|
||||
Tag,
|
||||
Token,
|
||||
URLs,
|
||||
URLs
|
||||
}
|
||||
|
||||
export default Mastodon
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ import StreamListener from './stream_listener'
|
|||
import WebSocket from './web_socket'
|
||||
import OAuth from './oauth'
|
||||
import Response from './response'
|
||||
import { RequestCanceledError } from './cancel'
|
||||
|
||||
const NO_REDIRECT = 'urn:ietf:wg:oauth:2.0:oob'
|
||||
const DEFAULT_URL = 'https://mastodon.social'
|
||||
|
|
@ -254,6 +255,13 @@ export default class Mastodon implements MegalodonInstance {
|
|||
},
|
||||
params
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
if (axios.isCancel(err)) {
|
||||
throw new RequestCanceledError(err.message)
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
})
|
||||
.then((resp: AxiosResponse<T>) => {
|
||||
const res: Response<T> = {
|
||||
data: resp.data,
|
||||
|
|
@ -278,6 +286,13 @@ export default class Mastodon implements MegalodonInstance {
|
|||
Authorization: `Bearer ${this.accessToken}`
|
||||
}
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
if (axios.isCancel(err)) {
|
||||
throw new RequestCanceledError(err.message)
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
})
|
||||
.then((resp: AxiosResponse<T>) => {
|
||||
const res: Response<T> = {
|
||||
data: resp.data,
|
||||
|
|
@ -302,6 +317,13 @@ export default class Mastodon implements MegalodonInstance {
|
|||
Authorization: `Bearer ${this.accessToken}`
|
||||
}
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
if (axios.isCancel(err)) {
|
||||
throw new RequestCanceledError(err.message)
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
})
|
||||
.then((resp: AxiosResponse<T>) => {
|
||||
const res: Response<T> = {
|
||||
data: resp.data,
|
||||
|
|
@ -351,6 +373,13 @@ export default class Mastodon implements MegalodonInstance {
|
|||
Authorization: `Bearer ${this.accessToken}`
|
||||
}
|
||||
})
|
||||
.catch((err: Error) => {
|
||||
if (axios.isCancel(err)) {
|
||||
throw new RequestCanceledError(err.message)
|
||||
} else {
|
||||
throw err
|
||||
}
|
||||
})
|
||||
.then((resp: AxiosResponse) => {
|
||||
const res: Response<T> = {
|
||||
data: resp.data,
|
||||
|
|
@ -409,5 +438,3 @@ export default class Mastodon implements MegalodonInstance {
|
|||
return streaming
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = Mastodon
|
||||
|
|
|
|||
Loading…
Reference in a new issue