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

Commit 256450e

Browse files
committed
update property heading names in docs
1 parent b44006a commit 256450e

File tree

1 file changed

+50
-50
lines changed

1 file changed

+50
-50
lines changed

README.md

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const { PastebinClient, PastebinError, Paste, User, ClientUser, PasteStore, User
2626
## PastebinClient
2727
The client used to interact with the Pastebin API.
2828

29-
### constructor()
29+
### .constructor()
3030
```js
3131
new PastebinClient(apiKey, username, password)
3232
```
@@ -38,7 +38,7 @@ new PastebinClient(apiKey, username, password)
3838
| username | Your Pastebin username | string | `null` |
3939
| password | Your Pastebin password | string | `null` |
4040

41-
### credentials
41+
### .credentials
4242
Your Pastebin credentials.
4343
**Type: [Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)**
4444

@@ -54,19 +54,19 @@ Your Pastebin username.
5454
Your Pastebin password.
5555
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
5656

57-
### user
57+
### .user
5858
The user the client logged in with, if it has.
5959
**Type: ?[ClientUser](#clientuser)**
6060

61-
### users
61+
### .users
6262
All of the cached users.
6363
**Type: ?[UserStore](#userstore)**
6464

65-
### pastes
65+
### .pastes
6666
All of the cached pastes.
6767
**Type: ?[PasteStore](#pastestore)**
6868

69-
### login()
69+
### .login()
7070
Login with the stored username and password and store the user key.
7171

7272
#### Returns
@@ -75,7 +75,7 @@ Login with the stored username and password and store the user key.
7575
## PastebinError
7676
Thrown when there's an error related to the Pastebin API or pastebin.js.
7777

78-
### constructor()
78+
### .constructor()
7979
```js
8080
new PastebinError(message)
8181
```
@@ -85,13 +85,13 @@ new PastebinError(message)
8585
|----------|-------------------|--------|---------|
8686
| message | The error message | string | |
8787

88-
### message
88+
### .message
8989
The error message.
9090

9191
## Paste
9292
A Pastebin paste.
9393

94-
### constructor()
94+
### .constructor()
9595
```js
9696
new Paste(client, data)
9797
```
@@ -113,65 +113,65 @@ new Paste(client, data)
113113
| data.expiryDate | The expiry date of the paste | Date | `null` |
114114
| data.hits | The number of times anyone saw the paste | number | `null` |
115115

116-
### client
116+
### .client
117117
The client used to get this paste.
118118
**Type: [PastebinClient](#pastebinclient)**
119119

120-
### key
120+
### .key
121121
The key of this paste.
122122
**Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
123123

124-
### url
124+
### .url
125125
The URL of this paste.
126126
**Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
127127

128-
### title
128+
### .title
129129
The title of this paste.
130130
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
131131

132-
### author
132+
### .author
133133
The author of this paste.
134134
**Type: ?[User](#user)**
135135

136-
### content
136+
### .content
137137
The content of this paste.
138138
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
139139

140-
### size
140+
### .size
141141
The length of the content of this paste.
142142
**Type: ?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
143143

144-
### date
144+
### .date
145145
The date this paste was posted.
146146
**Type: ?[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)**
147147

148-
### format
148+
### .format
149149
The format of this paste.
150150
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
151151

152-
### privacy
152+
### .privacy
153153
The privacy setting of this paste.
154154
**Type: ?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
155155

156-
### expiry
156+
### .expiry
157157
The expiry time of this paste.
158158
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
159159

160-
### expiryDate
160+
### .expiryDate
161161
The expiry date of this paste.
162162
**Type: ?[Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)**
163163

164-
### hits
164+
### .hits
165165
The number of times anyone saw this paste.
166166
**Type: ?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
167167

168-
### fetch()
168+
### .fetch()
169169
Fetch the content of this paste, and store it in the cache.
170170

171171
#### Returns
172172
**[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Paste](#paste)>**
173173

174-
### delete()
174+
### .delete()
175175
Delete this paste.
176176

177177
#### Returns
@@ -180,7 +180,7 @@ Delete this paste.
180180
## User
181181
A Pastebin user.
182182

183-
### constructor()
183+
### .constructor()
184184
```js
185185
new User(client, username)
186186
```
@@ -191,22 +191,22 @@ new User(client, username)
191191
| client | The client used to get this paste | PastebinClient | |
192192
| username | The user's username | string | |
193193

194-
### client
194+
### .client
195195
The client used to get this user.
196196
**Type: [PastebinClient](#pastebinclient)**
197197

198-
### username
198+
### .username
199199
This user's username.
200200
**Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
201201

202-
### me
202+
### .me
203203
Whether this user is the same as the client's user.
204204
**Type: [boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
205205

206206
## ClientUser *extends User*
207207
The Pastebin user of the logged in client.
208208

209-
### constructor()
209+
### .constructor()
210210
```js
211211
new ClientUser(client, data)
212212
```
@@ -226,50 +226,50 @@ new ClientUser(client, data)
226226
| data.location | The user's location | string | `null` |
227227
| data.pro | Whether the user is a PRO account | boolean | `null` |
228228

229-
### username
229+
### .username
230230
This user's username.
231231
**Type: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
232232

233-
### format
233+
### .format
234234
This user's format setting.
235235
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
236236

237-
### expiry
237+
### .expiry
238238
This user's expiry setting.
239239
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
240240

241-
### avatarURL
241+
### .avatarURL
242242
This user's avatar URL.
243243
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
244244

245-
### privacy
245+
### .privacy
246246
This user's privacy setting.
247247
**Type: ?[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)**
248248

249-
### website
249+
### .website
250250
This user's website.
251251
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
252252

253-
### email
253+
### .email
254254
This user's e-mail.
255255
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
256256

257-
### location
257+
### .location
258258
This user's location.
259259
**Type: ?[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)**
260260

261-
### pro
261+
### .pro
262262
Whether this user is a PRO account.
263263
**Type: ?[boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
264264

265-
### pastes
265+
### .pastes
266266
All of this user's cached pastes.
267267
**Type: ?[UserPasteStore](#userpastestore)**
268268

269269
## PasteStore *extends Map*
270270
A structure that holds all of the cached pastes.
271271

272-
### constructor()
272+
### .constructor()
273273
```js
274274
new PasteStore(client, entries)
275275
```
@@ -280,11 +280,11 @@ new PasteStore(client, entries)
280280
| client | The client the store belongs to | PastebinClient | |
281281
| entries | | Array<Array<string, Paste>> | `null` |
282282

283-
### client
283+
### .client
284284
The client this store belongs to.
285285
**Type: [PastebinClient](#pastebinclient)**
286286

287-
### fetch()
287+
### .fetch()
288288
Fetch a paste by its key, and store it in the cache.
289289

290290
#### Parameters
@@ -295,7 +295,7 @@ Fetch a paste by its key, and store it in the cache.
295295
#### Returns
296296
**[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Paste](#paste)>**
297297

298-
### create()
298+
### .create()
299299
Create a paste, and store it in the cache.
300300

301301
#### Parameters
@@ -314,7 +314,7 @@ Create a paste, and store it in the cache.
314314
## UserStore
315315
A structure that holds all of the cached users.
316316

317-
### constructor()
317+
### .constructor()
318318
```js
319319
new UserStore(client, entries)
320320
```
@@ -325,11 +325,11 @@ new UserStore(client, entries)
325325
| client | The client the store belongs to | PastebinClient | |
326326
| entries | | Array<Array<string, Paste>> | `null` |
327327

328-
### client
328+
### .client
329329
The client this store belongs to.
330330
**Type: [PastebinClient](#pastebinclient)**
331331

332-
### fetch()
332+
### .fetch()
333333
Fetch a user by their username, and store them in the cache.
334334

335335
#### Parameters
@@ -343,7 +343,7 @@ Fetch a user by their username, and store them in the cache.
343343
## UserPasteStore
344344
A structure that holds all of a user's cached pastes.
345345

346-
### constructor()
346+
### .constructor()
347347
```js
348348
new UserPasteStore()
349349
```
@@ -355,15 +355,15 @@ new UserPasteStore()
355355
| user | The user the store belongs to | User | |
356356
| entries | | Array<Array<string, Paste>> | `null` |
357357

358-
### client
358+
### .client
359359
The client this store belongs to.
360360
**Type: [PastebinClient](#pastebinclient)**
361361

362-
### user
362+
### .user
363363
The user this store belongs to.
364364
**Type: [User](#user)**
365365

366-
### fetch()
366+
### .fetch()
367367
Fetch this user's pastes, and store them in the cache.
368368

369369
#### Parameters

0 commit comments

Comments
 (0)