piral-auth/lib/create.d.ts

Plugin for handling authentication in Piral.

import { PiralPlugin } from 'piral-core';
import { PiletAuthApi, UserInfo } from './types';
/**
 * Available configuration options for the auth plugin.
 */
export interface AuthConfig {
    /**
     * Gets the current user, if any.
     */
    user?: UserInfo;
}
/**
 * Creates new Pilet API extensions for enabling authentication support.
 */
export declare function createAuthApi(config?: AuthConfig): PiralPlugin<PiletAuthApi>;