Skip to content

Commit c4062ff

Browse files
committed
Small fix for API-related whitespace.
1 parent 649cfa0 commit c4062ff

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

baselines/dom.generated.d.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3558,7 +3558,7 @@ declare var DOMException: {
35583558
readonly WRONG_DOCUMENT_ERR: number;
35593559
};
35603560

3561-
/** Represent an object providing methods which are not dependent on any particular document. Such an object is returned by the Document.implementation property. */
3561+
/** An object providing methods which are not dependent on any particular document. Such an object is returned by the Document.implementation property. */
35623562
interface DOMImplementation {
35633563
createDocument(namespaceURI: string | null, qualifiedName: string | null, doctype: DocumentType | null): Document;
35643564
createDocumentType(qualifiedName: string, publicId: string, systemId: string): DocumentType;
@@ -8867,7 +8867,7 @@ declare var IDBCursor: {
88678867
new(): IDBCursor;
88688868
};
88698869

8870-
/** Of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property. */
8870+
/** An interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property. */
88718871
interface IDBCursorWithValue extends IDBCursor {
88728872
/**
88738873
* Returns the cursor's current value.
@@ -9408,7 +9408,7 @@ declare var IntersectionObserver: {
94089408
new(callback: IntersectionObserverCallback, options?: IntersectionObserverInit): IntersectionObserver;
94099409
};
94109410

9411-
/** Of the Intersection Observer API describes the intersection between the target element and its root container at a specific moment of transition. */
9411+
/** An interface of the Intersection Observer API describes the intersection between the target element and its root container at a specific moment of transition. */
94129412
interface IntersectionObserverEntry {
94139413
readonly boundingClientRect: ClientRect | DOMRect;
94149414
readonly intersectionRatio: number;
@@ -9959,7 +9959,7 @@ declare var MediaKeySystemAccess: {
99599959
new(): MediaKeySystemAccess;
99609960
};
99619961

9962-
/** Of EncryptedMediaExtensions API the represents a set of keys that an associated HTMLMediaElement can use for decryption of media data during playback. */
9962+
/** An interface of the EncryptedMediaExtensions API the represents a set of keys that an associated HTMLMediaElement can use for decryption of media data during playback. */
99639963
interface MediaKeys {
99649964
createSession(sessionType?: MediaKeySessionType): MediaKeySession;
99659965
setServerCertificate(serverCertificate: BufferSource): Promise<boolean>;
@@ -11049,7 +11049,7 @@ declare var Path2D: {
1104911049
new(path?: Path2D | string): Path2D;
1105011050
};
1105111051

11052-
/** Of the Payment Request API is used to store shipping or payment address information. */
11052+
/** An interface of the Payment Request API is used to store shipping or payment address information. */
1105311053
interface PaymentAddress {
1105411054
readonly addressLine: string[];
1105511055
readonly city: string;
@@ -11107,7 +11107,7 @@ declare var PaymentRequestUpdateEvent: {
1110711107
new(type: string, eventInitDict?: PaymentRequestUpdateEventInit): PaymentRequestUpdateEvent;
1110811108
};
1110911109

11110-
/** Of the Payment Request API is returned after a user selects a payment method and approves a payment request. */
11110+
/** An interface of the Payment Request API is returned after a user selects a payment method and approves a payment request. */
1111111111
interface PaymentResponse {
1111211112
readonly details: any;
1111311113
readonly methodName: string;
@@ -12125,7 +12125,7 @@ interface ReadableByteStreamController {
1212512125
error(error?: any): void;
1212612126
}
1212712127

12128-
/** Of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. */
12128+
/** An interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. */
1212912129
interface ReadableStream<R = any> {
1213012130
readonly locked: boolean;
1213112131
cancel(reason?: any): Promise<void>;
@@ -17192,7 +17192,7 @@ interface WritableStreamDefaultWriter<W = any> {
1719217192
write(chunk: W): Promise<void>;
1719317193
}
1719417194

17195-
/** Represent an XML document. It inherits from the generic Document and does not add any specific methods or properties to it: nevertheless, several algorithms behave differently with the two types of documents. */
17195+
/** An XML document. It inherits from the generic Document and does not add any specific methods or properties to it: nevertheless, several algorithms behave differently with the two types of documents. */
1719617196
interface XMLDocument extends Document {
1719717197
addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: XMLDocument, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
1719817198
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;

baselines/webworker.generated.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1498,7 +1498,7 @@ declare var IDBCursor: {
14981498
new(): IDBCursor;
14991499
};
15001500

1501-
/** Of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property. */
1501+
/** An interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database. It is the same as the IDBCursor, except that it includes the value property. */
15021502
interface IDBCursorWithValue extends IDBCursor {
15031503
/**
15041504
* Returns the cursor's current value.
@@ -2421,7 +2421,7 @@ interface ReadableByteStreamController {
24212421
error(error?: any): void;
24222422
}
24232423

2424-
/** Of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. */
2424+
/** An interface of the Streams API represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object. */
24252425
interface ReadableStream<R = any> {
24262426
readonly locked: boolean;
24272427
cancel(reason?: any): Promise<void>;

src/index.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ function emitDom() {
3232

3333
// ${name} will be substituted with the name of an interface
3434
const removeVerboseIntroductions: (RegExp | [RegExp, string])[] = [
35-
[/^(The|A) ${name} interface of (the\s*)* ([a-z\s]+ API)(\\\'s)?/, 'An interface of the $3 '],
36-
/^(The|A) ${name} (interface|event|object) (is|represents|describes|defines)?/,
37-
/^An object implementing the ${name} interface (is|represents|describes|defines)/,
35+
[/^(The|A) ${name} interface of (the\s*)*([a-z\s]+ API)(\\\'s)?/, 'An interface of the $3 '],
36+
/^(The|A) ${name} (interface|event|object) (is|represents|represent|describes|defines)?/,
37+
/^An object implementing the ${name} interface (is|represents|represent|describes|defines)/,
3838
/^The ${name} is an interface representing/,
39-
/^This type (is|represents|describes|defines)?/,
39+
/^This type (is|represents|represent|describes|defines)?/,
4040

4141
[/^The ([a-z\s]+ API(\\\'s)?) ${name} (represents|is|describes|defines)/, 'The $1 ']
4242
];

0 commit comments

Comments
 (0)