Files
DefinitelyTyped/passport-jwt/index.d.ts
2016-04-27 21:53:46 -07:00

47 lines
1.5 KiB
TypeScript

// Type definitions for passport-jwt 2.0
// Project: https://github.com/themikenicholson/passport-jwt
// Definitions by: TANAKA Koichi <https://github.com/mugeso/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
import {Strategy as PassportStrategy} from 'passport-strategy';
import {Request} from 'express';
export declare class Strategy extends PassportStrategy {
constructor(opt: StrategyOptions, verify: VerifyCallback);
constructor(opt: StrategyOptions, verify: VerifyCallbackWithRequest);
}
export interface StrategyOptions {
secretOrKey: string;
jwtFromRequest: JwtFromRequestFunction;
issuer?: string;
audience?: string;
algorithms?: string[];
ignoreExpiration?: boolean;
passReqToCallback?: boolean;
}
export interface VerifyCallback {
(payload: any, done: VerifiedCallback): void;
}
export interface VerifyCallbackWithRequest {
(req: Request, payload: any, done: VerifiedCallback): void;
}
export interface VerifiedCallback {
(error: any, user?: any, info?: any): void;
}
export interface JwtFromRequestFunction {
(req: Request): string;
}
export declare namespace ExtractJwt {
export function fromHeader(header_name: string): JwtFromRequestFunction;
export function fromBodyField(field_name: string): JwtFromRequestFunction;
export function fromUrlQueryParameter(param_name: string): JwtFromRequestFunction;
export function fromAuthHeaderWithScheme(auth_scheme: string): JwtFromRequestFunction;
export function fromAuthHeader(): JwtFromRequestFunction;
}