instapaper-ts 1.0.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -0
- package/package.json +35 -35
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# instapaper-ts
|
|
2
|
+
|
|
3
|
+
`instapaper-ts` is an type-safe client for [Instapaper](https://instapaper.com).
|
|
4
|
+
|
|
5
|
+
Supports all available endpoints from the [Full Developer API](https://www.instapaper.com/api)!
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install --save-dev instapaper-ts
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { Instapaper } from "instapaper-ts";
|
|
19
|
+
|
|
20
|
+
const instapaper = new Instapaper(CONSUMER_KEY, CONSUMER_SECRET);
|
|
21
|
+
|
|
22
|
+
instapaper.setCredentials(USERNAME, PASSWORD);
|
|
23
|
+
|
|
24
|
+
const bookmarks = await instapaper.bookmarks.list({ limit: 50 });
|
|
25
|
+
|
|
26
|
+
console.log(bookmarks);
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Methods
|
|
30
|
+
|
|
31
|
+
See [Full API](https://www.instapaper.com/api) documentation for expected parameters and return types.
|
|
32
|
+
|
|
33
|
+
### Authentication
|
|
34
|
+
|
|
35
|
+
- setCredentials
|
|
36
|
+
- verifyCredentials
|
|
37
|
+
|
|
38
|
+
### Bookmarks
|
|
39
|
+
|
|
40
|
+
- list
|
|
41
|
+
- updateReadProgress
|
|
42
|
+
- add
|
|
43
|
+
- delete
|
|
44
|
+
- star
|
|
45
|
+
- unstar
|
|
46
|
+
- archive
|
|
47
|
+
- unarchive
|
|
48
|
+
- move
|
|
49
|
+
- getText
|
|
50
|
+
|
|
51
|
+
### Folders
|
|
52
|
+
|
|
53
|
+
- list
|
|
54
|
+
- add
|
|
55
|
+
- delete
|
|
56
|
+
- setOrder
|
|
57
|
+
|
|
58
|
+
### Highlights
|
|
59
|
+
|
|
60
|
+
- list
|
|
61
|
+
- add
|
|
62
|
+
- delete
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## Terms of Use
|
|
67
|
+
|
|
68
|
+
Please read the full Instapaper [Terms of Use](https://www.instapaper.com/api/terms) before using this library.
|
package/package.json
CHANGED
|
@@ -1,37 +1,37 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
2
|
+
"name": "instapaper-ts",
|
|
3
|
+
"version": "1.1.1",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "A type-safe API client for Instapaper.",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"/dist"
|
|
10
|
+
],
|
|
11
|
+
"scripts": {
|
|
12
|
+
"build": "tsup",
|
|
13
|
+
"dev": "tsup --watch"
|
|
14
|
+
},
|
|
15
|
+
"keywords": [
|
|
16
|
+
"instapaper",
|
|
17
|
+
"read",
|
|
18
|
+
"later",
|
|
19
|
+
"typescript",
|
|
20
|
+
"library"
|
|
21
|
+
],
|
|
22
|
+
"author": "Ben Silverman (bensilverman.co.uk)",
|
|
23
|
+
"homepage": "https://github.com/benslv/instapaper-ts",
|
|
24
|
+
"bugs": {
|
|
25
|
+
"url": "https://github.com/benslv/instapaper-ts/issues"
|
|
26
|
+
},
|
|
27
|
+
"license": "MIT",
|
|
28
|
+
"packageManager": "pnpm@10.4.1",
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"oauth-1.0a": "^2.2.6"
|
|
31
|
+
},
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@types/node": "^22.13.5",
|
|
34
|
+
"tsup": "^8.4.0",
|
|
35
|
+
"typescript": "^5.8.2"
|
|
36
|
+
}
|
|
37
37
|
}
|