hors/dist/transaction/transaction.d.ts

Node.js API framework

/// <reference types="node" />
import { Request, Response, CookieOptions, NextFunction } from 'express';
export declare type TransactionRequestInfo = {
    correlationId: string;
    url: string;
    ipAddress: string;
};
declare type OnTransactionEndCallback = () => void;
export declare class Transaction<UserType = any> {
    send: Send;
    private correlationId;
    private request;
    private response;
    private nextFunction;
    private user;
    constructor(request: Request, response: Response, correlationId: string, onEndCallback: OnTransactionEndCallback);
    getBody(): {
        [key: string]: any;
    };
    getCookies(): {
        [key: string]: any;
    };
    getExpressNextFunction(): NextFunction;
    getExpressRequest(): Request;
    getExpressResponse(): Response;
    getParams(): {
        [key: string]: any;
    };
    getQuery(): {
        [key: string]: any;
    };
    getRequestInfo(): TransactionRequestInfo;
    getUser(): UserType;
    redirect(url: string): void;
    setCookie(name: string, value: string, options?: CookieOptions): void;
    setExpressNextFunction(next: NextFunction): void;
    setUser(user: UserType): void;
}
declare type SendData = string | Buffer | {
    [key: string]: any;
} | Array<{
    [key: string]: any;
}>;
declare class Send {
    private response;
    private onEndCallback;
    constructor(response: Response, onEndCallback: OnTransactionEndCallback);
    ok(payload?: SendData): void;
    created(payload?: SendData): void;
    accepted(payload?: SendData): void;
    noContent(): void;
    partialContent(payload?: SendData): void;
    movedPermanently(payload?: SendData): void;
    found(payload?: SendData): void;
    notModified(payload?: SendData): void;
    badRequest(payload?: SendData): void;
    unauthorized(payload?: SendData): void;
    forbidden(payload?: SendData): void;
    notFound(payload?: SendData): void;
    methodNotAllowed(payload?: SendData): void;
    internalServerError(payload?: SendData): void;
    notImplemented(payload?: SendData): void;
    private send;
}
export default Transaction;