From e4db641ce36ead24c6d473e6a8726f6c7ed1cf6c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 18 Dec 2024 14:43:45 +0000 Subject: [PATCH] Extract API --- docs/review/api/alfa-assert.api.md | 2 ++ docs/review/api/alfa-command.api.md | 4 ++++ docs/review/api/alfa-crawler.api.md | 1 + docs/review/api/alfa-frontier.api.md | 4 ++-- docs/review/api/alfa-scraper.api.md | 6 ++++++ docs/review/api/alfa-test-utils.api.md | 2 ++ 6 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/review/api/alfa-assert.api.md b/docs/review/api/alfa-assert.api.md index 4915dd13..eaac500f 100644 --- a/docs/review/api/alfa-assert.api.md +++ b/docs/review/api/alfa-assert.api.md @@ -16,6 +16,7 @@ import type { Rule } from '@siteimprove/alfa-act'; // @public (undocumented) export class Asserter { + protected constructor(rules: Array>, handlers: Array>, options: Asserter.Options); // (undocumented) readonly expect: (input: I, options?: Assertion.Options) => Assertion; // (undocumented) @@ -31,6 +32,7 @@ export namespace Asserter { // @public (undocumented) export class Assertion { + protected constructor(input: I, rules: Array>, handlers: Array>, options: Assertion.Options); // (undocumented) accessible(): Future>; // (undocumented) diff --git a/docs/review/api/alfa-command.api.md b/docs/review/api/alfa-command.api.md index fd80e839..36a8f0e8 100644 --- a/docs/review/api/alfa-command.api.md +++ b/docs/review/api/alfa-command.api.md @@ -17,6 +17,7 @@ import type { Thunk } from '@siteimprove/alfa-thunk'; // @public (undocumented) export class Argument implements Functor, Serializable { + protected constructor(name: string, description: string, options: Argument.Options, parse: Argument.Parser); // (undocumented) choices(...choices: Array): Argument; // (undocumented) @@ -86,6 +87,7 @@ export namespace Argument { // @public (undocumented) export class Command implements Serializable { + protected constructor(name: string, version: string, description: string, flags: F, args: A, subcommands: Mapper, parent: Option, run?: (command: Command) => Command.Runner); // (undocumented) get arguments(): A; // (undocumented) @@ -169,6 +171,7 @@ export namespace Command { // @public (undocumented) export class Flag implements Functor, Serializable { + protected constructor(name: string, description: string, options: Flag.Options, parse: Flag.Parser]>); // (undocumented) alias(alias: string): Flag; // (undocumented) @@ -253,6 +256,7 @@ export namespace Flag { // (undocumented) export type Parser = []> = parser.Parser, Set, string, A>; export class Set implements Functor { + protected constructor(value: T, parse: Flag.Parser); // (undocumented) map(mapper: Mapper): Set; // (undocumented) diff --git a/docs/review/api/alfa-crawler.api.md b/docs/review/api/alfa-crawler.api.md index a7524924..2da77462 100644 --- a/docs/review/api/alfa-crawler.api.md +++ b/docs/review/api/alfa-crawler.api.md @@ -14,6 +14,7 @@ import { URL as URL_2 } from '@siteimprove/alfa-url'; // @public (undocumented) export class Crawler { + protected constructor(scraper: Scraper); close(): Promise; crawl(frontier: Frontier, options?: Crawler.crawl.Options): AsyncIterable>; // (undocumented) diff --git a/docs/review/api/alfa-frontier.api.md b/docs/review/api/alfa-frontier.api.md index 47083d7a..6d8a616b 100644 --- a/docs/review/api/alfa-frontier.api.md +++ b/docs/review/api/alfa-frontier.api.md @@ -12,6 +12,8 @@ import { URL as URL_2 } from '@siteimprove/alfa-url'; // @public (undocumented) export class Frontier implements Equatable, Serializable { + // Warning: (ae-forgotten-export) The symbol "Item" needs to be exported by the entry point index.d.ts + protected constructor(scope: URL_2, items: Array); complete(url: string | URL_2): boolean; dequeue(): Option; enqueue(url: string | URL_2): boolean; @@ -54,8 +56,6 @@ export namespace Frontier { export interface JSON { // (undocumented) [key: string]: json.JSON; - // Warning: (ae-forgotten-export) The symbol "Item" needs to be exported by the entry point index.d.ts - // // (undocumented) items: Array; // (undocumented) diff --git a/docs/review/api/alfa-scraper.api.md b/docs/review/api/alfa-scraper.api.md index 1fd882d9..3d6f4383 100644 --- a/docs/review/api/alfa-scraper.api.md +++ b/docs/review/api/alfa-scraper.api.md @@ -25,6 +25,7 @@ import { URL as URL_2 } from '@siteimprove/alfa-url'; // @public (undocumented) export class Archive implements Equatable, Serializable { + protected constructor(path: string, format: Archive.Format); // (undocumented) equals(value: Archive): boolean; // (undocumented) @@ -75,6 +76,7 @@ export namespace Awaiter { // @public (undocumented) export class Credentials implements Equatable, Serializable { + protected constructor(username: string, password: string); // (undocumented) equals(value: unknown): value is this; // (undocumented) @@ -104,6 +106,7 @@ export namespace Credentials { // @public (undocumented) export class Scraper { + protected constructor(browser: puppeteer.Browser); close(): Promise; // (undocumented) static of(browser?: Promise): Promise; @@ -142,6 +145,7 @@ export namespace Scraper { // @public (undocumented) export class Screenshot implements Equatable, Serializable { + protected constructor(path: string, type: Screenshot.Type); // (undocumented) equals(value: unknown): value is this; // (undocumented) @@ -171,6 +175,7 @@ export namespace Screenshot { export namespace Type { // (undocumented) export class JPEG implements Equatable, Serializable { + protected constructor(quality: number); // (undocumented) equals(value: unknown): value is this; // (undocumented) @@ -198,6 +203,7 @@ export namespace Screenshot { export type JSON = PNG.JSON | JPEG.JSON; // (undocumented) export class PNG implements Equatable, Serializable { + protected constructor(background: boolean); // (undocumented) get background(): boolean; // (undocumented) diff --git a/docs/review/api/alfa-test-utils.api.md b/docs/review/api/alfa-test-utils.api.md index 8b5e314e..3253ed5e 100644 --- a/docs/review/api/alfa-test-utils.api.md +++ b/docs/review/api/alfa-test-utils.api.md @@ -27,6 +27,7 @@ export type alfaOutcome = Outcome { + protected constructor(page: Page, outcomes: Map_2>, resultAggregates: Audit.ResultAggregates, durations: Performance.Durations); get alfaVersion(): typeof alfaVersion; get durations(): Performance.Durations; // (undocumented) @@ -105,6 +106,7 @@ export interface CommitInformation { // @public export class Logging implements Equatable, json.Serializable { + protected constructor(title: string, logs: Sequence); // (undocumented) equals(value: Logging): boolean; // (undocumented)