bun-types 1.2.20-canary.20250801T140826 → 1.2.20-canary.20250803T140532

package/vendor/expect-type/messages.d.ts

@@ -0,0 +1,395 @@
+/*
+   Copyright 2024 Misha Kaletsky
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+*/
+
+import type { StrictEqualUsingBranding } from "./branding";
+import type { And, Extends, ExtendsExcludingAnyOrNever, IsAny, IsNever, IsUnknown, Not, UsefulKeys } from "./utils";
+/**
+ * Determines the printable type representation for a given type.
+ */
+export type PrintType<T> =
+  IsUnknown<T> extends true
+    ? "unknown"
+    : IsNever<T> extends true
+      ? "never"
+      : IsAny<T> extends true
+        ? never
+        : boolean extends T
+          ? "boolean"
+          : T extends boolean
+            ? `literal boolean: ${T}`
+            : string extends T
+              ? "string"
+              : T extends string
+                ? `literal string: ${T}`
+                : number extends T
+                  ? "number"
+                  : T extends number
+                    ? `literal number: ${T}`
+                    : bigint extends T
+                      ? "bigint"
+                      : T extends bigint
+                        ? `literal bigint: ${T}`
+                        : T extends null
+                          ? "null"
+                          : T extends undefined
+                            ? "undefined"
+                            : T extends (...args: any[]) => any
+                              ? "function"
+                              : "...";
+/**
+ * Helper for showing end-user a hint why their type assertion is failing.
+ * This swaps "leaf" types with a literal message about what the actual and
+ * expected types are. Needs to check for `Not<IsAny<Actual>>` because
+ * otherwise `LeafTypeOf<Actual>` returns `never`, which extends everything 🤔
+ */
+export type MismatchInfo<Actual, Expected> =
+  And<[Extends<PrintType<Actual>, "...">, Not<IsAny<Actual>>]> extends true
+    ? And<[Extends<any[], Actual>, Extends<any[], Expected>]> extends true
+      ? Array<MismatchInfo<Extract<Actual, any[]>[number], Extract<Expected, any[]>[number]>>
+      : {
+          [K in UsefulKeys<Actual> | UsefulKeys<Expected>]: MismatchInfo<
+            K extends keyof Actual ? Actual[K] : never,
+            K extends keyof Expected ? Expected[K] : never
+          >;
+        }
+    : StrictEqualUsingBranding<Actual, Expected> extends true
+      ? Actual
+      : `Expected: ${PrintType<Expected>}, Actual: ${PrintType<Exclude<Actual, Expected>>}`;
+/**
+ * @internal
+ */
+declare const inverted: unique symbol;
+/**
+ * @internal
+ */
+type Inverted<T> = {
+  [inverted]: T;
+};
+/**
+ * @internal
+ */
+declare const expectNull: unique symbol;
+export type ExpectNull<T> = {
+  [expectNull]: T;
+  result: ExtendsExcludingAnyOrNever<T, null>;
+};
+/**
+ * @internal
+ */
+declare const expectUndefined: unique symbol;
+export type ExpectUndefined<T> = {
+  [expectUndefined]: T;
+  result: ExtendsExcludingAnyOrNever<T, undefined>;
+};
+/**
+ * @internal
+ */
+declare const expectNumber: unique symbol;
+export type ExpectNumber<T> = {
+  [expectNumber]: T;
+  result: ExtendsExcludingAnyOrNever<T, number>;
+};
+/**
+ * @internal
+ */
+declare const expectString: unique symbol;
+export type ExpectString<T> = {
+  [expectString]: T;
+  result: ExtendsExcludingAnyOrNever<T, string>;
+};
+/**
+ * @internal
+ */
+declare const expectBoolean: unique symbol;
+export type ExpectBoolean<T> = {
+  [expectBoolean]: T;
+  result: ExtendsExcludingAnyOrNever<T, boolean>;
+};
+/**
+ * @internal
+ */
+declare const expectVoid: unique symbol;
+export type ExpectVoid<T> = {
+  [expectVoid]: T;
+  result: ExtendsExcludingAnyOrNever<T, void>;
+};
+/**
+ * @internal
+ */
+declare const expectFunction: unique symbol;
+export type ExpectFunction<T> = {
+  [expectFunction]: T;
+  result: ExtendsExcludingAnyOrNever<T, (...args: any[]) => any>;
+};
+/**
+ * @internal
+ */
+declare const expectObject: unique symbol;
+export type ExpectObject<T> = {
+  [expectObject]: T;
+  result: ExtendsExcludingAnyOrNever<T, object>;
+};
+/**
+ * @internal
+ */
+declare const expectArray: unique symbol;
+export type ExpectArray<T> = {
+  [expectArray]: T;
+  result: ExtendsExcludingAnyOrNever<T, any[]>;
+};
+/**
+ * @internal
+ */
+declare const expectSymbol: unique symbol;
+export type ExpectSymbol<T> = {
+  [expectSymbol]: T;
+  result: ExtendsExcludingAnyOrNever<T, symbol>;
+};
+/**
+ * @internal
+ */
+declare const expectAny: unique symbol;
+export type ExpectAny<T> = {
+  [expectAny]: T;
+  result: IsAny<T>;
+};
+/**
+ * @internal
+ */
+declare const expectUnknown: unique symbol;
+export type ExpectUnknown<T> = {
+  [expectUnknown]: T;
+  result: IsUnknown<T>;
+};
+/**
+ * @internal
+ */
+declare const expectNever: unique symbol;
+export type ExpectNever<T> = {
+  [expectNever]: T;
+  result: IsNever<T>;
+};
+/**
+ * @internal
+ */
+declare const expectNullable: unique symbol;
+export type ExpectNullable<T> = {
+  [expectNullable]: T;
+  result: Not<StrictEqualUsingBranding<T, NonNullable<T>>>;
+};
+/**
+ * @internal
+ */
+declare const expectBigInt: unique symbol;
+export type ExpectBigInt<T> = {
+  [expectBigInt]: T;
+  result: ExtendsExcludingAnyOrNever<T, bigint>;
+};
+/**
+ * Checks if the result of an expecter matches the specified options, and
+ * resolves to a fairly readable error message if not.
+ */
+export type Scolder<
+  Expecter extends {
+    result: boolean;
+  },
+  Options extends {
+    positive: boolean;
+  },
+> = Expecter["result"] extends Options["positive"]
+  ? () => true
+  : Options["positive"] extends true
+    ? Expecter
+    : Inverted<Expecter>;
+export {};