8000 docs: document PasteCreateOptions && fix PastebinCredentials · cAttte/pastebin.js@8624b27 · GitHub
[go: up one dir, main page]

Skip to content
This repository was archived by the owner on Jul 6, 2025. It is now read-only.

Commit 8624b27

Browse files
committed
docs: document PasteCreateOptions && fix PastebinCredentials
1 parent ff31583 commit 8624b27

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

readme.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ console.log(paste.url)
3131
- [UserPasteStore](#userpastestore)
3232
- [Typedefs](#typedefs)
3333
- [PastebinCredentials](#pastebincredentials)
34+
- [PasteCreateOptions](#pastecreateoptions)
3435
- [Format](#format-2)
3536
- [Privacy](#privacy-2)
3637
- [Expiry](#expiry-2)
@@ -474,7 +475,9 @@ Fetch this user's pastes, and store them in the cache.
474475

475476
The credentials provided to and stored in the PastebinClient.
476477

477-
**Type:** `{ apiKey?: string, username?: string, password?: string, userKey?: string }`
478+
**Type:** `{ apiKey?, username?, password?, userKey? }`
479+
480+
#### Properties
478481

479482
| name | description | type | default |
480483
| -------- | ------------------------------------------------ | ------ | ------- |
@@ -483,8 +486,21 @@ The credentials provided to and stored in the PastebinClient.
483486
| password | Your Pastebin password | 8000 string | `null` |
484487
| userKey | Your Pastebin user key, obtained when logging in | string | `null` |
485488

489+
### PasteCreateOptions
490+
491+
Options to create a paste.
492+
493+
**Type:** `{ title?, format?, privacy?, expiry? }`
494+
486495
#### Properties
487496

497+
| name | description | type | default |
498+
| ------- | ------------------------------------------------ | --------------------- | ------- |
499+
| title | Your Pastebin API key | string | `null` |
500+
| format | Your Pastebin username | [Format](#format-2) | `null` |
501+
| privacy | Your Pastebin password | [Privacy](#privacy-2) | `null` |
502+
| expiry | Your Pastebin user key, obtained when logging in | [Expiry](#expiry-2) | `null` |
503+
488504
### Format
489505

490506
A "format," which will be used for syntax highlighting. You can see the full list of formats [here](https://pastebin.com/doc_api#5).

0 commit comments

Comments
 (0)
0