Skip to content

Commit

Permalink
Extract API
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 18, 2024
1 parent c0a3cc0 commit e4db641
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/review/api/alfa-assert.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import type { Rule } from '@siteimprove/alfa-act';

// @public (undocumented)
export class Asserter<I, T extends Hashable, Q extends Question.Metadata, S> {
protected constructor(rules: Array<Rule<I, T, Q, S>>, handlers: Array<Handler<I, T, Q, S>>, options: Asserter.Options<I, T, Q, S>);
// (undocumented)
readonly expect: (input: I, options?: Assertion.Options<I, T, Q, S>) => Assertion<I, T, Q, S>;
// (undocumented)
Expand All @@ -31,6 +32,7 @@ export namespace Asserter {

// @public (undocumented)
export class Assertion<I, T extends Hashable, Q extends Question.Metadata, S> {
protected constructor(input: I, rules: Array<Rule<I, T, Q, S>>, handlers: Array<Handler<I, T, Q, S>>, options: Assertion.Options<I, T, Q, S>);
// (undocumented)
accessible(): Future<Result<string>>;
// (undocumented)
Expand Down
4 changes: 4 additions & 0 deletions docs/review/api/alfa-command.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import type { Thunk } from '@siteimprove/alfa-thunk';

// @public (undocumented)
export class Argument<T = unknown> implements Functor<T>, Serializable<Argument.JSON> {
protected constructor(name: string, description: string, options: Argument.Options, parse: Argument.Parser<T>);
// (undocumented)
choices<U extends T>(...choices: Array<U>): Argument<U>;
// (undocumented)
Expand Down Expand Up @@ -86,6 +87,7 @@ export namespace Argument {

// @public (undocumented)
export class Command<F extends Command.Flags = {}, A extends Command.Arguments = {}, S extends Command.Subcommands = {}> implements Serializable<Command.JSON> {
protected constructor(name: string, version: string, description: string, flags: F, args: A, subcommands: Mapper<Command, S>, parent: Option<Command>, run?: (command: Command<F, A, S>) => Command.Runner<F, A>);
// (undocumented)
get arguments(): A;
// (undocumented)
Expand Down Expand Up @@ -169,6 +171,7 @@ export namespace Command {

// @public (undocumented)
export class Flag<T = unknown> implements Functor<T>, Serializable<Flag.JSON> {
protected constructor(name: string, description: string, options: Flag.Options, parse: Flag.Parser<T, [Predicate<string>]>);
// (undocumented)
alias(alias: string): Flag<T>;
// (undocumented)
Expand Down Expand Up @@ -253,6 +256,7 @@ export namespace Flag {
// (undocumented)
export type Parser<T, A extends Array<unknown> = []> = parser.Parser<Array<string>, Set<T>, string, A>;
export class Set<T> implements Functor<T> {
protected constructor(value: T, parse: Flag.Parser<T>);
// (undocumented)
map<U>(mapper: Mapper<T, U>): Set<U>;
// (undocumented)
Expand Down
1 change: 1 addition & 0 deletions docs/review/api/alfa-crawler.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import { URL as URL_2 } from '@siteimprove/alfa-url';

// @public (undocumented)
export class Crawler {
protected constructor(scraper: Scraper);
close(): Promise<void>;
crawl(frontier: Frontier, options?: Crawler.crawl.Options): AsyncIterable<Result<Page, [URL_2, string]>>;
// (undocumented)
Expand Down
4 changes: 2 additions & 2 deletions docs/review/api/alfa-frontier.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<Item>);
complete(url: string | URL_2): boolean;
dequeue(): Option<URL_2>;
enqueue(url: string | URL_2): boolean;
Expand Down Expand Up @@ -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<Item.JSON>;
// (undocumented)
Expand Down
6 changes: 6 additions & 0 deletions docs/review/api/alfa-scraper.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -104,6 +106,7 @@ export namespace Credentials {

// @public (undocumented)
export class Scraper {
protected constructor(browser: puppeteer.Browser);
close(): Promise<void>;
// (undocumented)
static of(browser?: Promise<puppeteer.Browser>): Promise<Scraper>;
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions docs/review/api/alfa-test-utils.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export type alfaOutcome = Outcome<Flattened.Input, Flattened.Target, Flattened.Q

// @public
export class Audit implements json.Serializable<Audit.JSON> {
protected constructor(page: Page, outcomes: Map_2<string, Sequence<alfaOutcome>>, resultAggregates: Audit.ResultAggregates, durations: Performance.Durations);
get alfaVersion(): typeof alfaVersion;
get durations(): Performance.Durations;
// (undocumented)
Expand Down Expand Up @@ -105,6 +106,7 @@ export interface CommitInformation {

// @public
export class Logging implements Equatable, json.Serializable<Logging.JSON> {
protected constructor(title: string, logs: Sequence<Logging>);
// (undocumented)
equals(value: Logging): boolean;
// (undocumented)
Expand Down

0 comments on commit e4db641

Please sign in to comment.