Skip to content

Commit 60915b7

Browse files
committed
[doc] Replace jsdoc entirely with typedoc for the documentation system
1 parent 8436d3b commit 60915b7

File tree

134 files changed

+1351
-9176
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

134 files changed

+1351
-9176
lines changed

docs/dts/Event.d.ts

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -107,17 +107,17 @@ interface Data extends Event {
107107
push(bytes: Data | string): Data;
108108

109109
/**
110-
* Remove bytes from the beginning.
110+
* Removes bytes from the beginning.
111111
*/
112112
shift(count: number): Data;
113113

114114
/**
115-
* Remove bytes from the beginning up to the first byte where user callback returns true.
115+
* Removes bytes from the beginning up to the first byte where user callback returns true.
116116
*/
117117
shiftTo(callback: (byte: number) => boolean): Data;
118118

119119
/**
120-
* Remove bytes from the beginning until user callback returns false.
120+
* Removes bytes from the beginning until user callback returns false.
121121
*/
122122
shiftWhile(callback: (byte: number) => boolean): Data;
123123

@@ -132,12 +132,28 @@ interface DataConstructor {
132132
/**
133133
* Creates an instance of _Data_.
134134
*/
135-
new(): Data;
136-
new(bytes: number[]): Data;
137-
new(text: string, encoding?: 'utf8' | 'hex' | 'base64' | 'base64url'): Data;
138-
new(data: Data): Data;
135+
new(): Data;
139136

140-
from(text: string, encoding?: 'utf8' | 'hex' | 'base64' | 'base64url'): Data;
137+
/**
138+
* Creates an instance of _Data_ from an array of bytes.
139+
* @param bytes - An array of numbers representing the bytes.
140+
*/
141+
new(bytes: number[]): Data;
142+
new(text: string, encoding?: 'utf8' | 'hex' | 'base64' | 'base64url'): Data;
143+
new(data: Data): Data;
144+
145+
/**
146+
* Converts a string to an instance of _Data_.
147+
*
148+
* @param text - A string to convert to _Data_.
149+
* @param encoding - Interpretation of the characters. The following are supported:
150+
* - _"utf8"_: (default) Encode the text as UTF-8
151+
* - _"hex"_: Decode the text as hexadecimal representation
152+
* - _"base64"_: Decode the text as Base64 format
153+
* - _"base64url"_: Decode the text as Base64URL format
154+
* @returns Instance of _Data_ converted from the string.
155+
*/
156+
from(text: string, encoding?: 'utf8' | 'hex' | 'base64' | 'base64url'): Data;
141157
}
142158

143159
declare var MessageStart: MessageStartConstructor;

docs/dts/URL.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ interface URLSearchParams {
105105
* Makes an object with the key-value pairs.
106106
*/
107107
toObject(): { [name: string]: string | string[] };
108+
109+
/**
110+
* Composes the query string.
111+
*/
112+
toString(): string;
108113
}
109114

110115
interface URLSearchParamsConstructor {

docs/dts/crypto.d.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,11 @@ interface VerifyConstructor {
216216
* JSON Web Key.
217217
*/
218218
interface JWK {
219+
220+
/**
221+
* Whether the token is valid.
222+
*/
223+
readonly isValid: boolean;
219224
}
220225

221226
interface JWKConstructor {

0 commit comments

Comments
 (0)