@withstudiocms/auth-kit/dist/utils/unsafeCheck.d.ts

Utilities for managing authentication

/** biome-ignore-all lint/suspicious/noTsIgnore: Working with auto-generated modules */
import { Effect } from '@withstudiocms/effect';
declare const CheckIfUnsafe_base: Effect.Service.Class<CheckIfUnsafe, "studiocms/virtuals/auth/utils/unsafeCheck/CheckIfUnsafe", {
    readonly effect: Effect.Effect<{
        username: (val: string) => Effect.Effect<boolean, import("../errors.js").CheckIfUnsafeError, never>;
        password: (val: string) => Effect.Effect<boolean, import("../errors.js").CheckIfUnsafeError, never>;
    }, never, never>;
}>;
/**
 * A service class that provides utility functions to check if a value is unsafe,
 * such as being a reserved username or a password.
 *
 * @remarks
 * This service uses logging and effect-based programming to perform the checks.
 *
 * @example
 * ```typescript
 * const checkIfUnsafe = CheckIfUnsafe;
 * const isReservedUsername = yield* checkIfUnsafe.username('admin');
 * const isPassword = yield* checkIfUnsafe.password('123456');
 * ```
 *
 * @class
 * @implements {Effect.Service<CheckIfUnsafe>}
 */
export declare class CheckIfUnsafe extends CheckIfUnsafe_base {
}
export {};