@nhost/nhost-js/dist/utils/types.d.ts

Nhost JavaScript SDK

import { NhostAuthConstructorParams } from '@nhost/hasura-auth-js';

export interface ErrorPayload<TMessage = any> {
    error: string;
    status: number;
    message: TMessage;
}
export interface ActionErrorState {
    /**
     * @return `true` if an error occurred
     * @depreacted use `!isSuccess` or `!!error` instead
     * */
    isError: boolean;
    /** Provides details about the error */
    error: ErrorPayload | null;
}
export interface ActionLoadingState {
    /**
     * @return `true` when the action is executing, `false` when it finished its execution.
     */
    isLoading: boolean;
}
export interface ActionSuccessState {
    /** Returns `true` if the action is successful. */
    isSuccess: boolean;
}
export type Subdomain = {
    /**
     * Project subdomain (e.g. `ieingiwnginwnfnegqwvdqwdwq`)
     * Use `localhost` during local development
     */
    subdomain: string;
    /**
     * Project region (e.g. `eu-central-1`)
     * Project region is not required during local development (when `subdomain` is `localhost`)
     */
    region?: string;
    /**
     * When set, the admin secret is sent as a header, `x-hasura-admin-secret`,
     * for all requests to GraphQL, Storage, and Serverless Functions.
     */
    adminSecret?: string;
};
export type ServiceUrls = {
    authUrl?: string;
    graphqlUrl?: string;
    storageUrl?: string;
    functionsUrl?: string;
};
export interface NhostClientConstructorParams extends Partial<Subdomain>, Partial<ServiceUrls>, Omit<NhostAuthConstructorParams, 'url' | 'broadcastKey'> {
    /**
     * When set, the admin secret is sent as a header, `x-hasura-admin-secret`,
     * for all requests to GraphQL, Storage, and Serverless Functions.
     */
    adminSecret?: string;
}
//# sourceMappingURL=types.d.ts.map