Documents / @faasjs/test / FuncWarper

Class: FuncWarper

Test Wrapper for a func

import { FuncWarper } from '@faasjs/test'

const func = new FuncWarper(__dirname + '/../demo.func.ts')

expect(await func.handler()).toEqual('Hello, world')

Indexable

[key: string]: any

Constructors

new FuncWarper(initBy)

new FuncWarper(initBy): FuncWarper

Parameters

initBy: Func<any, any, any>

Returns

FuncWarper

new FuncWarper(initBy)

new FuncWarper(initBy): FuncWarper

Parameters

initBy: string

Returns

FuncWarper

Properties

config

readonly config: Config

file

readonly file: string

func

readonly func: Func<any, any, any>

logger

readonly logger: Logger

plugins

readonly plugins: Plugin[]

staging

readonly staging: string

Methods

JSONhandler()

JSONhandler<TData>(body?, options?): Promise<Object>

Type parameters

TData = any

Parameters

body?

options?= undefined

options.cookie?

options.headers?

options.session?

Returns

Promise<Object>

body

body: any

optional cookie: Record<string, any>

data?

optional data: TData

error?

optional error: Object

error.message

message: string

headers

headers: Object

Index signature

[key: string]: string

session?

optional session: Record<string, any>

statusCode

statusCode: number

handler()

handler<TResult>(event, context): Promise<TResult>

Type parameters

TResult = any

Parameters

event: any= undefined

context: any= undefined

Returns

Promise<TResult>

mount()

mount(handler?): Promise<void>

Parameters

handler?

Returns

Promise<void>