@udibo/oauth2 0.1.0

package/esm/deps/jsr.io/@std/testing/1.0.20/bdd.d.ts

@@ -0,0 +1,382 @@
+import { type DescribeDefinition, type ItDefinition, type TestSuite } from "./_test_suite.js";
+export type { DescribeDefinition, ItDefinition, TestSuite };
+/**
+ * The arguments for an ItFunction.
+ *
+ * @deprecated This will be removed in 2.0.0 together with {@linkcode it}.
+ * Use `node:test`'s `it()` instead.
+ */
+export type ItArgs<T> = [options: ItDefinition<T>] | [
+    name: string,
+    options: Omit<ItDefinition<T>, "name">
+] | [
+    name: string,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [fn: (this: T, t: Deno.TestContext) => void | Promise<void>] | [
+    name: string,
+    options: Omit<ItDefinition<T>, "fn" | "name">,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    options: Omit<ItDefinition<T>, "fn">,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    options: Omit<ItDefinition<T>, "fn" | "name">,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    suite: TestSuite<T>,
+    name: string,
+    options: Omit<ItDefinition<T>, "name" | "suite">
+] | [
+    suite: TestSuite<T>,
+    name: string,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    suite: TestSuite<T>,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    suite: TestSuite<T>,
+    name: string,
+    options: Omit<ItDefinition<T>, "fn" | "name" | "suite">,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    suite: TestSuite<T>,
+    options: Omit<ItDefinition<T>, "fn" | "suite">,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+] | [
+    suite: TestSuite<T>,
+    options: Omit<ItDefinition<T>, "fn" | "name" | "suite">,
+    fn: (this: T, t: Deno.TestContext) => void | Promise<void>
+];
+/**
+ * Registers an individual test case.
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `it()` or
+ * `Deno.test()` instead.
+ */
+export interface it {
+    <T>(...args: ItArgs<T>): void;
+    /** Registers an individual test case with only set to true. */
+    only<T>(...args: ItArgs<T>): void;
+    /** Registers an individual test case with ignore set to true. */
+    ignore<T>(...args: ItArgs<T>): void;
+    /**
+     * Registers an individual test case with ignore set to true. Alias of
+     * `.ignore()`.
+     */
+    skip<T>(...args: ItArgs<T>): void;
+}
+/**
+ * Registers an individual test case.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function to implement the test case
+ * @param args The test case
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `it()` or
+ * `Deno.test()` instead.
+ */
+export declare function it<T>(...args: ItArgs<T>): void;
+export declare namespace it {
+    var only: <T>(...args: ItArgs<T>) => void;
+    var ignore: <T>(...args: ItArgs<T>) => void;
+    var skip: <T>(...args: ItArgs<T>) => void;
+}
+/**
+ * Alias of {@linkcode it}
+ *
+ * Registers an individual test case.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { test } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * test("a test case", () => {
+ *   // test case
+ *   assertEquals(2 + 2, 4);
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function to implement the test case
+ * @param args The test case
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `test()` or
+ * `Deno.test()` instead.
+ */
+export declare function test<T>(...args: ItArgs<T>): void;
+export declare namespace test {
+    var only: <T>(...args: ItArgs<T>) => void;
+    var ignore: <T>(...args: ItArgs<T>) => void;
+    var skip: <T>(...args: ItArgs<T>) => void;
+}
+/**
+ * Run some shared setup before all of the tests in the group.
+ * Useful for async setup in `describe` blocks. Outside them,
+ * top-level initialization code should be used instead.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it, beforeAll } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * beforeAll(() => {
+ *  console.log("beforeAll");
+ * });
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function
+ * @param fn The function to implement the setup behavior.
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `before()` or
+ * `Deno.test.beforeAll()` (Deno 2.5+) instead.
+ */
+export declare function beforeAll<T>(fn: (this: T) => void | Promise<void>): void;
+/**
+ * Alias of {@linkcode beforeAll}
+ *
+ * Run some shared setup before all of the tests in the suite.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it, before } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * before(() => {
+ *  console.log("before");
+ * });
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function
+ * @param fn The function to implement the setup behavior.
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `before()` or
+ * `Deno.test.beforeAll()` (Deno 2.5+) instead.
+ */
+export declare function before<T>(fn: (this: T) => void | Promise<void>): void;
+/**
+ * Run some shared teardown after all of the tests in the suite.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it, afterAll } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * afterAll(() => {
+ *  console.log("afterAll");
+ * });
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function
+ * @param fn The function to implement the teardown behavior.
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `after()` or
+ * `Deno.test.afterAll()` (Deno 2.5+) instead.
+ */
+export declare function afterAll<T>(fn: (this: T) => void | Promise<void>): void;
+/**
+ * Alias of {@linkcode afterAll}.
+ *
+ * Run some shared teardown after all of the tests in the suite.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it, after } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * after(() => {
+ *  console.log("after");
+ * });
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function
+ * @param fn The function to implement the teardown behavior.
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `after()` or
+ * `Deno.test.afterAll()` (Deno 2.5+) instead.
+ */
+export declare function after<T>(fn: (this: T) => void | Promise<void>): void;
+/**
+ * Run some shared setup before each test in the suite.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it, beforeEach } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * beforeEach(() => {
+ *  console.log("beforeEach");
+ * });
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function
+ * @param fn The function to implement the shared setup behavior
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `beforeEach()`
+ * or `Deno.test.beforeEach()` (Deno 2.5+) instead.
+ */
+export declare function beforeEach<T>(fn: (this: T) => void | Promise<void>): void;
+/**
+ * Run some shared teardown after each test in the suite.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it, afterEach } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * afterEach(() => {
+ *  console.log("afterEach");
+ * });
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the function
+ * @param fn The function to implement the shared teardown behavior
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `afterEach()`
+ * or `Deno.test.afterEach()` (Deno 2.5+) instead.
+ */
+export declare function afterEach<T>(fn: (this: T) => void | Promise<void>): void;
+/**
+ * The arguments for a DescribeFunction.
+ *
+ * @deprecated This will be removed in 2.0.0 together with {@linkcode describe}.
+ * Use `node:test`'s `describe()` instead.
+ */
+export type DescribeArgs<T> = [options: DescribeDefinition<T>] | [name: string] | [
+    name: string,
+    options: Omit<DescribeDefinition<T>, "name">
+] | [name: string, fn: () => void | undefined] | [fn: () => void | undefined] | [
+    name: string,
+    options: Omit<DescribeDefinition<T>, "fn" | "name">,
+    fn: () => void | undefined
+] | [
+    options: Omit<DescribeDefinition<T>, "fn">,
+    fn: () => void | undefined
+] | [
+    options: Omit<DescribeDefinition<T>, "fn" | "name">,
+    fn: () => void | undefined
+] | [
+    suite: TestSuite<T>,
+    name: string
+] | [
+    suite: TestSuite<T>,
+    name: string,
+    options: Omit<DescribeDefinition<T>, "name" | "suite">
+] | [
+    suite: TestSuite<T>,
+    name: string,
+    fn: () => void | undefined
+] | [
+    suite: TestSuite<T>,
+    fn: () => void | undefined
+] | [
+    suite: TestSuite<T>,
+    name: string,
+    options: Omit<DescribeDefinition<T>, "fn" | "name" | "suite">,
+    fn: () => void | undefined
+] | [
+    suite: TestSuite<T>,
+    options: Omit<DescribeDefinition<T>, "fn" | "suite">,
+    fn: () => void | undefined
+] | [
+    suite: TestSuite<T>,
+    options: Omit<DescribeDefinition<T>, "fn" | "name" | "suite">,
+    fn: () => void | undefined
+];
+/**
+ * Registers a test suite.
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `describe()`
+ * instead.
+ */
+export interface describe {
+    <T>(...args: DescribeArgs<T>): TestSuite<T>;
+    /** Registers a test suite with only set to true. */
+    only<T>(...args: DescribeArgs<T>): TestSuite<T>;
+    /** Registers a test suite with ignore set to true. */
+    ignore<T>(...args: DescribeArgs<T>): TestSuite<T>;
+    /** Registers a test suite with ignore set to true. Alias of `.ignore()`. */
+    skip<T>(...args: ItArgs<T>): void;
+}
+/**
+ * Registers a test suite.
+ *
+ * @example Usage
+ * ```ts ignore
+ * import { describe, it } from "@std/testing/bdd";
+ * import { assertEquals } from "@std/assert";
+ *
+ * describe("example", () => {
+ *   it("should pass", () => {
+ *     // test case
+ *     assertEquals(2 + 2, 4);
+ *   });
+ * });
+ * ```
+ *
+ * @typeParam T The self type of the test suite body.
+ * @param args The test suite body.
+ * @returns The test suite
+ *
+ * @deprecated This will be removed in 2.0.0. Use `node:test`'s `describe()`
+ * instead.
+ */
+export declare function describe<T>(...args: DescribeArgs<T>): TestSuite<T>;
+export declare namespace describe {
+    var only: <T>(...args: DescribeArgs<T>) => TestSuite<T>;
+    var ignore: <T>(...args: DescribeArgs<T>) => TestSuite<T>;
+    var skip: <T>(...args: DescribeArgs<T>) => TestSuite<T>;
+}