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

Commit e12cc23

Browse files
committed
docs: remove data properties from param lists for simplicity
1 parent 8624b27 commit e12cc23

File tree

1 file changed

+8
-28
lines changed

1 file changed

+8
-28
lines changed

readme.md

Lines changed: 8 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -131,21 +131,10 @@ new Paste(client, data)
131131

132132
##### Parameters
133133

134-
| name | description | type | default |
135-
| --------------- | ---------------------------------------- | --------------------- | ------- |
136-
| client | The client used to get this paste | PastebinClient | |
137-
| data | | Object | |
138-
| data.key | The key of the paste | string | |
139-
| data.title | The title of the paste | string | `null` |
140-
| data.author | The author of the paste | User | `null` |
141-
| data.content | The content of the paste | string | `null` |
142-
| data.size | The length of the content of the paste | number | `null` |
143-
| data.date | The date the paste was posted | Date | `null` |
144-
| data.format | The format of the paste | [Format](#format-2) | `null` |
145-
| data.privacy | The privacy setting of the paste | [Privacy](#privacy-2) | `null` |
146-
| data.expiry | The expiry time of the paste | [Expiry](#expiry-2) | `null` |
147-
| data.expiryDate | The expiry date of the paste | Date | `null` |
148-
| data.hits | The number of times anyone saw the paste | number | `null` |
134+
| name | description | type | default |
135+
| ------ | --------------------------------- | -------------- | ------- |
136+
| client | The client used to get this paste | PastebinClient | |
137+
| data | The data obtained from the API | Object | |
149138

150139
#### .client
151140

@@ -272,19 +261,10 @@ new ClientUser(client, data)
272261

273262
##### Parameters
274263

275-
| name | description | type | default |
276-
| -------------- | --------------------------------- | --------------------- | ------- |
277-
| client | The client used to get this paste | PastebinClient | |
278-
| data | | Object | |
279-
| data.username | The user's username | string | |
280-
| data.format | The user's format setting | [Format](#format-2) | `null` |
281-
| data.expiry | The user's expiry setting | [Expiry](#expiry-2) | `null` |
282-
| data.avatarURL | The user's avatar URL | string | `null` |
283-
| data.privacy | The user's privacy setting | [Privacy](#privacy-2) | `null` |
284-
| data.website | The user's website | string | `null` |
285-
| data.email | The user's e-mail | string | `null` |
286-
| data.location | The user's location | string | `null` |
287-
| data.pro | Whether the user is a PRO account | boolean | `null` |
264+
| name | description | type | default |
265+
| ------ | --------------------------------- | -------------- | ------- |
266+
| client | The client used to get this paste | PastebinClient | |
267+
| data | The data obtained from the API | Object | |
288268

289269
#### .username
290270

0 commit comments

Comments
 (0)