@warp-drive/core 5.6.0-alpha.15 → 5.6.0-alpha.18

package/declarations/store/-private/new-core-tmp/promise-state.d.ts

@@ -1,255 +1,263 @@
-import type { Awaitable } from '../../../request.ts';
+import type { Awaitable } from "../../../request.js";
 /**
- * The state of a promise in the "pending"
- * state. This is the default initial state.
- *
- */
+* The state of a promise in the "pending"
+* state. This is the default initial state.
+*
+*/
 export interface PendingPromise {
-    /**
-     * The status of the promise.
-     *
-     */
-    status: 'pending';
-    /**
-     * Whether the promise is pending.
-     *
-     */
-    isPending: true;
-    /**
-     * Whether the promise is pending.
-     *
-     * @deprecated use `isPending` instead
-     */
-    isLoading: true;
-    /**
-     * Whether the promise has resolved
-     * successfully.
-     *
-     */
-    isSuccess: false;
-    /**
-     * Whether the promise has rejected
-     * with an error.
-     *
-     */
-    isError: false;
-    /**
-     * Once the promise has resolved, this will
-     * be the value the promise resolved to.
-     *
-     */
-    value: null;
-    /**
-     * Once the promise has resolved, this will
-     * be the value the promise resolved to.
-     *
-     * @deprecated use `value` instead
-     */
-    result: null;
-    /**
-     * Once the promise has rejected, this will
-     * be the error the promise rejected with.
-     *
-     *
-     * @deprecated use `reason` instead
-     */
-    error: null;
-    /**
-     * Once the promise has rejected, this will
-     * be the error the promise rejected with.
-     *
-     */
-    reason: null;
+	/**
+	* The status of the promise.
+	*
+	*/
+	status: "pending";
+	/**
+	* Whether the promise is pending.
+	*
+	*/
+	isPending: true;
+	/**
+	* Whether the promise is pending.
+	*
+	* @deprecated use `isPending` instead
+	*/
+	isLoading: true;
+	/**
+	* Whether the promise has resolved
+	* successfully.
+	*
+	*/
+	isSuccess: false;
+	/**
+	* Whether the promise has rejected
+	* with an error.
+	*
+	*/
+	isError: false;
+	/**
+	* Once the promise has resolved, this will
+	* be the value the promise resolved to.
+	*
+	*/
+	value: null;
+	/**
+	* Once the promise has resolved, this will
+	* be the value the promise resolved to.
+	*
+	* @deprecated use `value` instead
+	*/
+	result: null;
+	/**
+	* Once the promise has rejected, this will
+	* be the error the promise rejected with.
+	*
+	*
+	* @deprecated use `reason` instead
+	*/
+	error: null;
+	/**
+	* Once the promise has rejected, this will
+	* be the error the promise rejected with.
+	*
+	*/
+	reason: null;
 }
 /**
- * The state of a promise in the "fulfilled" state.
- * This is the state of a promise that has resolved
- * successfully.
- *
- */
+* The state of a promise in the "fulfilled" state.
+* This is the state of a promise that has resolved
+* successfully.
+*
+*/
 export interface ResolvedPromise<T> {
-    /**
-     * The status of the promise.
-     *
-     */
-    status: 'fulfilled';
-    /**
-     * Whether the promise is pending.
-     *
-     */
-    isPending: false;
-    /**
-     * Whether the promise is pending.
-     *
-     * @deprecated use `isPending` instead
-     */
-    isLoading: false;
-    /**
-     * Whether the promise has resolved
-     * successfully.
-     *
-     */
-    isSuccess: true;
-    /**
-     * Whether the promise has rejected
-     * with an error.
-     *
-     */
-    isError: false;
-    /**
-     * Once the promise has resolved, this will
-     * be the value the promise resolved to.
-     *
-     */
-    value: T;
-    /**
-     * Once the promise has resolved, this will
-     * be the value the promise resolved to.
-     *
-     * @deprecated use `value` instead
-     */
-    result: T;
-    /**
-     * Once the promise has rejected, this will
-     * be the error the promise rejected with.
-     *
-     *
-     * @deprecated use `reason` instead
-     */
-    error: null;
-    /**
-     * Once the promise has rejected, this will
-     * be the error the promise rejected with.
-     *
-     */
-    reason: null;
+	/**
+	* The status of the promise.
+	*
+	*/
+	status: "fulfilled";
+	/**
+	* Whether the promise is pending.
+	*
+	*/
+	isPending: false;
+	/**
+	* Whether the promise is pending.
+	*
+	* @deprecated use `isPending` instead
+	*/
+	isLoading: false;
+	/**
+	* Whether the promise has resolved
+	* successfully.
+	*
+	*/
+	isSuccess: true;
+	/**
+	* Whether the promise has rejected
+	* with an error.
+	*
+	*/
+	isError: false;
+	/**
+	* Once the promise has resolved, this will
+	* be the value the promise resolved to.
+	*
+	*/
+	value: T;
+	/**
+	* Once the promise has resolved, this will
+	* be the value the promise resolved to.
+	*
+	* @deprecated use `value` instead
+	*/
+	result: T;
+	/**
+	* Once the promise has rejected, this will
+	* be the error the promise rejected with.
+	*
+	*
+	* @deprecated use `reason` instead
+	*/
+	error: null;
+	/**
+	* Once the promise has rejected, this will
+	* be the error the promise rejected with.
+	*
+	*/
+	reason: null;
 }
 /**
- * The state of a promise in the "rejected" state.
- * This is the state of a promise that has rejected
- * with an error.
- *
- */
+* The state of a promise in the "rejected" state.
+* This is the state of a promise that has rejected
+* with an error.
+*
+*/
 export interface RejectedPromise<E> {
-    /**
-     * The status of the promise.
-     *
-     */
-    status: 'rejected';
-    /**
-     * Whether the promise is pending.
-     *
-     */
-    isPending: false;
-    /**
-     * Whether the promise is pending.
-     *
-     * @deprecated use `isPending` instead
-     */
-    isLoading: false;
-    /**
-     * Whether the promise has resolved
-     * successfully.
-     *
-     */
-    isSuccess: false;
-    /**
-     * Whether the promise has rejected
-     * with an error.
-     *
-     */
-    isError: true;
-    /**
-     * Once the promise has resolved, this will
-     * be the value the promise resolved to.
-     *
-     */
-    value: null;
-    /**
-     * Once the promise has resolved, this will
-     * be the value the promise resolved to.
-     *
-     * @deprecated use `value` instead
-     */
-    result: null;
-    /**
-     * Once the promise has rejected, this will
-     * be the error the promise rejected with.
-     *
-     *
-     * @deprecated use `reason` instead
-     */
-    error: E;
-    /**
-     * Once the promise has rejected, this will
-     * be the error the promise rejected with.
-     *
-     */
-    reason: E;
+	/**
+	* The status of the promise.
+	*
+	*/
+	status: "rejected";
+	/**
+	* Whether the promise is pending.
+	*
+	*/
+	isPending: false;
+	/**
+	* Whether the promise is pending.
+	*
+	* @deprecated use `isPending` instead
+	*/
+	isLoading: false;
+	/**
+	* Whether the promise has resolved
+	* successfully.
+	*
+	*/
+	isSuccess: false;
+	/**
+	* Whether the promise has rejected
+	* with an error.
+	*
+	*/
+	isError: true;
+	/**
+	* Once the promise has resolved, this will
+	* be the value the promise resolved to.
+	*
+	*/
+	value: null;
+	/**
+	* Once the promise has resolved, this will
+	* be the value the promise resolved to.
+	*
+	* @deprecated use `value` instead
+	*/
+	result: null;
+	/**
+	* Once the promise has rejected, this will
+	* be the error the promise rejected with.
+	*
+	*
+	* @deprecated use `reason` instead
+	*/
+	error: E;
+	/**
+	* Once the promise has rejected, this will
+	* be the error the promise rejected with.
+	*
+	*/
+	reason: E;
 }
 /**
- * The state of a promise. This is the type that is returned
- * from `getPromiseState`.
- *
- * See also:
- * - {@link PendingPromise}
- * - {@link ResolvedPromise}
- * - {@link RejectedPromise}
- *
- */
-export type PromiseState<T = unknown, E = unknown> = PendingPromise | ResolvedPromise<T> | RejectedPromise<E>;
-export declare function createPromiseState<T, E>(promise: Promise<T> | Awaitable<T, E>): Readonly<PromiseState<T, E>>;
+* The state of a promise. This is the type that is returned
+* from `getPromiseState`.
+*
+* See also:
+* - {@link PendingPromise}
+* - {@link ResolvedPromise}
+* - {@link RejectedPromise}
+*
+*/
+export type PromiseState<
+	T = unknown,
+	E = unknown
+> = PendingPromise | ResolvedPromise<T> | RejectedPromise<E>;
+export declare function createPromiseState<
+	T,
+	E
+>(promise: Promise<T> | Awaitable<T, E>): Readonly<PromiseState<T, E>>;
 /**
- * Returns a reactive state-machine for the provided promise or awaitable.
- *
- * Repeat calls to `getPromiseState` with the same promise will return the same state object
- * making is safe and easy to use in templates and JavaScript code to produce reactive
- * behaviors around promises.
- *
- * `getPromiseState` can be used in both JavaScript and Template contexts.
- *
- * ```ts
- * import { getPromiseState } from '@warp-drive/ember';
- *
- * const state = getPromiseState(promise);
- * ```
- *
- * For instance, we could write a getter on a component that updates whenever
- * the promise state advances or the promise changes, by combining the function
- * with the use of `@cached`
- *
- * ```ts
- * class Component {
- *   @cached
- *   get title() {
- *     const state = getPromiseState(this.args.request);
- *     if (state.isPending) {
- *       return 'loading...';
- *     }
- *     if (state.isError) { return null; }
- *     return state.result.title;
- *   }
- * }
- * ```
- *
- * Or in a template as a helper:
- *
- * ```gjs
- * import { getPromiseState } from '@warp-drive/ember';
- *
- * <template>
- *   {{#let (getPromiseState @request) as |state|}}
- *     {{#if state.isPending}} <Spinner />
- *     {{else if state.isError}} <ErrorForm @error={{state.error}} />
- *     {{else}}
- *       <h1>{{state.result.title}}</h1>
- *     {{/if}}
- *   {{/let}}
- * </template>
- * ```
- *
- * If looking to use in a template, consider also the `<Await />` component.
- *
- */
-export declare function getPromiseState<T = unknown, E = unknown>(promise: Promise<T> | Awaitable<T, E>): Readonly<PromiseState<T, E>>;
-//# sourceMappingURL=promise-state.d.ts.map
+* Returns a reactive state-machine for the provided promise or awaitable.
+*
+* Repeat calls to `getPromiseState` with the same promise will return the same state object
+* making is safe and easy to use in templates and JavaScript code to produce reactive
+* behaviors around promises.
+*
+* `getPromiseState` can be used in both JavaScript and Template contexts.
+*
+* ```ts
+* import { getPromiseState } from '@warp-drive/ember';
+*
+* const state = getPromiseState(promise);
+* ```
+*
+* For instance, we could write a getter on a component that updates whenever
+* the promise state advances or the promise changes, by combining the function
+* with the use of `@cached`
+*
+* ```ts
+* class Component {
+*   @cached
+*   get title() {
+*     const state = getPromiseState(this.args.request);
+*     if (state.isPending) {
+*       return 'loading...';
+*     }
+*     if (state.isError) { return null; }
+*     return state.result.title;
+*   }
+* }
+* ```
+*
+* Or in a template as a helper:
+*
+* ```gjs
+* import { getPromiseState } from '@warp-drive/ember';
+*
+* <template>
+*   {{#let (getPromiseState @request) as |state|}}
+*     {{#if state.isPending}} <Spinner />
+*     {{else if state.isError}} <ErrorForm @error={{state.error}} />
+*     {{else}}
+*       <h1>{{state.result.title}}</h1>
+*     {{/if}}
+*   {{/let}}
+* </template>
+* ```
+*
+* If looking to use in a template, consider also the `<Await />` component.
+*
+*/
+export declare function getPromiseState<
+	T = unknown,
+	E = unknown
+>(promise: Promise<T> | Awaitable<T, E>): Readonly<PromiseState<T, E>>;