Reference

@blinkk/root-password-protect

Password-protected pages for Root.js sites. This reference is generated from the package's TypeScript types and doc comments.

import {…} from '@blinkk/root-password-protect';

function generateHash(password: string, salt: string): Promise<string>;

function hashPassword(password: string): Promise<{
    hash: string;
    salt: string;
}>;

function verifyPassword(password: string, hash: string, salt: string): Promise<boolean>;

@blinkk/root-password-protect/plugin

import {…} from '@blinkk/root-password-protect/plugin';

interface PasswordProtectedRoute

Members (2)

source: string;

URL glob pattern to match (regex not supported yet).

password: {
    hash: string;
    salt: string;
};

enum PasswordProtectError {
    UNKNOWN = "UNKNOWN",
    PASSWORD_REQUIRED = "PASSWORD_REQUIRED",
    PASSWORD_INVALID = "PASSWORD_INVALID"
}

function passwordProtectPlugin(options: PasswordProtectPluginOptions): Plugin;

interface PasswordProtectPluginOptions

Members (1)

protectedRoutes: PasswordProtectedRoute[];

function renderPasswordPage(req: Request, res: Response, options?: {
    error?: PasswordProtectError;
}): Promise<void>;

Renders the login page to a response.