Modules

Module @midwayjs/mock

Modules

"egg"

Classes

Interfaces

Type aliases

Variables

References

BaseMockApplication

BaseMockApplication:

EggMock

EggMock:

MidwayApplicationOptions

MidwayApplicationOptions:

MidwayMockApplication

MidwayMockApplication:

MidwayMockContext

MidwayMockContext:

MidwaySocketIOClientOptions

MidwaySocketIOClientOptions:

MockApplication

MockApplication:

MockClassFunctionHandler

MockClassFunctionHandler:

MockOption

MockOption:

SocketIOWrapperClient

SocketIOWrapperClient:

close

close:

create

create:

createApp

createApp:

createBootstrap

createBootstrap:

createFunctionApp

createFunctionApp:

createHttpRequest

createHttpRequest:

createLightApp

createLightApp:

createRabbitMQProducer

createRabbitMQProducer:

createSocketIOClient

createSocketIOClient:

createWebSocketClient

createWebSocketClient:

Type aliases

EggContext

EggContext: ReturnType<MockApplication["mockContext"]>

deprecated

MockAppConfigurationOptions

MockAppConfigurationOptions: object

Type declaration

Optional baseDir?: string
Optional bootstrapTimeout?: number
Optional cleanLogsDir?: boolean
Optional cleanTempDir?: boolean
Optional entryFile?: string

MockClassFunctionHandler

MockClassFunctionHandler: function

deprecated

Type declaration

- (this: MidwayMockApplication, className: string, methodName: string, fnOrData: any): any
- Parameters
  - this: MidwayMockApplication
  - className: string
  - methodName: string
  - fnOrData: any
  Returns any

MockHttpClientResult

MockHttpClientResult: ResultObject | ResultFunction | string

ResultFunction

ResultFunction: function

Type declaration

- (url?: string, opts?: any): ResultObject | string | void
- Parameters
  - Optional url: string
  - Optional opts: any
  Returns ResultObject | string | void

Variables

Const EventEmitter

EventEmitter: any = require('events').EventEmitter

Const appMap

appMap: WeakMap<object, any> = new WeakMap()

Const bootstrapAppSet

bootstrapAppSet: Set<object> = (global['MIDWAY_BOOTSTRAP_APP_SET'] = new Set<{framework: IMidwayFramework<any, any>;starter: BootstrapStarter;}>())

Const eventListeners

eventListeners: any[] = []

Const exchanges

exchanges: object

Type declaration

Let lastAppDir

lastAppDir: any

Const queues

queues: object

Type declaration

Functions

close

close(app: IMidwayApplication | IMidwayFramework<any, any>, options?: object): Promise<void>

- Defined in packages/mock/src/utils.ts:225
Parameters
- app: IMidwayApplication | IMidwayFramework<any, any>
- Optional options: object
  - Optional cleanLogsDir?: boolean
  - Optional cleanTempDir?: boolean
  - Optional sleep?: number
Returns Promise<void>

Const connect

connect(): Promise<object>

- Defined in packages/mock/src/client/rabbitMQ.ts:298
Returns Promise<object>

create

create<T, U>(appDir?: string, options?: U & MockAppConfigurationOptions, customFrameworkName?: string | MidwayFrameworkType | any): Promise<T>

- Defined in packages/mock/src/utils.ts:85
Type parameters
- T: IMidwayFramework<any, U>
- U
Parameters
- Default value appDir: string = process.cwd()
- Optional options: U & MockAppConfigurationOptions
- Optional customFrameworkName: string | MidwayFrameworkType | any
Returns Promise<T>

createApp

createApp<T, U, Y>(baseDir?: string, options?: U & MockAppConfigurationOptions, customFrameworkName?: string | MidwayFrameworkType | any): Promise<Y>

- Defined in packages/mock/src/utils.ts:208
Type parameters
- T: IMidwayFramework<any, U>
- U
- Y
Parameters
- Default value baseDir: string = process.cwd()
- Optional options: U & MockAppConfigurationOptions
- Optional customFrameworkName: string | MidwayFrameworkType | any
Returns Promise<Y>

createBootstrap

createBootstrap(entryFile: string): Promise<BootstrapAppStarter>

- Defined in packages/mock/src/utils.ts:314
Parameters
- entryFile: string
Returns Promise<BootstrapAppStarter>

Const createChannel

createChannel(): Promise<object>

- Defined in packages/mock/src/client/rabbitMQ.ts:118
Returns Promise<object>

Const createConfirmChannel

createConfirmChannel(): Promise<object>

- Defined in packages/mock/src/client/rabbitMQ.ts:202
Returns Promise<object>

Const createConfirmQueue

createConfirmQueue(): object

- Defined in packages/mock/src/client/rabbitMQ.ts:32
Returns object
- add: function
  - add(item: any): void
  - - Defined in packages/mock/src/client/rabbitMQ.ts:37
    Parameters
    - item: any
    Returns void
- addConsumer: function
  - addConsumer(consumer: any, waitForConfirms: any): Promise<void>
  - - Defined in packages/mock/src/client/rabbitMQ.ts:45
    Parameters
    - consumer: any
    - waitForConfirms: any
    Returns Promise<void>
- get: function
  - get(): any
  - - Defined in packages/mock/src/client/rabbitMQ.ts:44
    Returns any
- getMessageCount: function
  - getMessageCount(): number
  - - Defined in packages/mock/src/client/rabbitMQ.ts:55
    Returns number
- purge: function
  - purge(): any[]
  - - Defined in packages/mock/src/client/rabbitMQ.ts:56
    Returns any[]
- stopConsume: function
  - stopConsume(): any
  - - Defined in packages/mock/src/client/rabbitMQ.ts:54
    Returns any

Const createDirectExchange

createDirectExchange(): object

- Defined in packages/mock/src/client/rabbitMQ.ts:76
Returns object
- bindQueue: function
  - bindQueue(queueName: any, pattern: any, options: any): void
  - - Defined in packages/mock/src/client/rabbitMQ.ts:79
    Parameters
    - queueName: any
    - pattern: any
    - options: any
    Returns void
- getTargetQueues: function
  - getTargetQueues(routingKey: any, options?: object): any[]
  - - Defined in packages/mock/src/client/rabbitMQ.ts:86
    Parameters
    - routingKey: any
    - Default value options: object = {}
    Returns any[]

Const createFanoutExchange

createFanoutExchange(): object

- Defined in packages/mock/src/client/rabbitMQ.ts:60
Returns object
- bindQueue: function
  - bindQueue(queueName: any, pattern: any, options: any): void
  - - Defined in packages/mock/src/client/rabbitMQ.ts:63
    Parameters
    - queueName: any
    - pattern: any
    - options: any
    Returns void
- getTargetQueues: function
  - getTargetQueues(routingKey: any, options?: object): any[]
  - - Defined in packages/mock/src/client/rabbitMQ.ts:70
    Parameters
    - routingKey: any
    - Default value options: object = {}
    Returns any[]

createFunctionApp

createFunctionApp<T, U, Y>(baseDir?: string, options?: U & MockAppConfigurationOptions, customFrameworkName?: string | MidwayFrameworkType | any): Promise<Y>

- Defined in packages/mock/src/utils.ts:266
Type parameters
- T: IMidwayFramework<any, U>
- U
- Y
Parameters
- Default value baseDir: string = process.cwd()
- Optional options: U & MockAppConfigurationOptions
- Optional customFrameworkName: string | MidwayFrameworkType | any
Returns Promise<Y>

Const createHeadersExchange

createHeadersExchange(): object

- Defined in packages/mock/src/client/rabbitMQ.ts:95
Returns object
- bindQueue: function
  - bindQueue(queueName: any, pattern: any, options: any): void
  - - Defined in packages/mock/src/client/rabbitMQ.ts:98
    Parameters
    - queueName: any
    - pattern: any
    - options: any
    Returns void
- getTargetQueues: function
  - getTargetQueues(routingKey: any, options?: any): any[]
  - - Defined in packages/mock/src/client/rabbitMQ.ts:105
    Parameters
    - routingKey: any
    - Default value options: any = {}
    Returns any[]

createHttpRequest

createHttpRequest(app: IMidwayApplication): SuperTest<Test>

- Defined in packages/mock/src/client/http.ts:4
Parameters
- app: IMidwayApplication
Returns SuperTest<Test>

createLightApp

createLightApp(baseDir?: string, options?: MockAppConfigurationOptions): Promise<IMidwayApplication>

- Defined in packages/mock/src/utils.ts:287
Parameters
- Default value baseDir: string = process.cwd()
- Optional options: MockAppConfigurationOptions
Returns Promise<IMidwayApplication>

Const createQueue

createQueue(): object

- Defined in packages/mock/src/client/rabbitMQ.ts:8
Returns object
- add: function
  - add(item: any): void
  - - Defined in packages/mock/src/client/rabbitMQ.ts:13
    Parameters
    - item: any
    Returns void
- addConsumer: function
  - addConsumer(consumer: any): void
  - - Defined in packages/mock/src/client/rabbitMQ.ts:21
    Parameters
    - consumer: any
    Returns void
- get: function
  - get(): any
  - - Defined in packages/mock/src/client/rabbitMQ.ts:20
    Returns any
- getMessageCount: function
  - getMessageCount(): number
  - - Defined in packages/mock/src/client/rabbitMQ.ts:27
    Returns number
- purge: function
  - purge(): any[]
  - - Defined in packages/mock/src/client/rabbitMQ.ts:28
    Returns any[]
- stopConsume: function
  - stopConsume(): any
  - - Defined in packages/mock/src/client/rabbitMQ.ts:26
    Returns any

createRabbitMQProducer

createRabbitMQProducer(options: object): Promise<ChannelManager>
createRabbitMQProducer(queueName: string, options: object): Promise<ChannelManager>

- Defined in packages/mock/src/client/rabbitMQ.ts:368
Parameters
- options: object
  - Optional url?: string
Returns Promise<ChannelManager>
- Defined in packages/mock/src/client/rabbitMQ.ts:371
Parameters
- queueName: string
- options: object
  - Optional isConfirmChannel?: boolean
  - Optional mock?: boolean
  - Optional url?: string
Returns Promise<ChannelManager>

createSocketIOClient

createSocketIOClient(opts: MidwaySocketIOClientOptions): Promise<SocketIOWrapperClient & EventEmitter>

- Defined in packages/mock/src/client/socketio.ts:58
Parameters
- opts: MidwaySocketIOClientOptions
Returns Promise<SocketIOWrapperClient & EventEmitter>

createWebSocketClient

createWebSocketClient(address: string | URL, options?: ClientOptions | ClientRequestArgs): Promise<WebSocket>

- Defined in packages/mock/src/client/ws.ts:5
Parameters
- address: string | URL
- Optional options: ClientOptions | ClientRequestArgs
Returns Promise<WebSocket>

findFirstExistModule

findFirstExistModule(moduleList: any): string

- Defined in packages/mock/src/utils.ts:31
Parameters
- moduleList: any
Returns string

formatPath

formatPath(baseDir: any, p: any): any

- Defined in packages/mock/src/utils.ts:67
Parameters
- baseDir: any
- p: any
Returns any

getIncludeFramework

getIncludeFramework(dependencies: any): string

- Defined in packages/mock/src/utils.ts:49
Parameters
- dependencies: any
Returns string

isTestEnvironment

isTestEnvironment(): boolean

- Defined in packages/mock/src/utils.ts:18
Returns boolean

isWin32

isWin32(): boolean

- Defined in packages/mock/src/utils.ts:27
Returns boolean

Const mockClassFunction

mockClassFunction(this: MidwayMockApplicationInner, className: string, methodName: string, fnOrData: any): void

- Defined in packages/mock/src/app/extend/application.ts:15
Parameters
- this: MidwayMockApplicationInner
- className: string
- methodName: string
- fnOrData: any
Returns void

Module @midwayjs/mock

References

Modules

Classes

Interfaces

Type aliases

Variables

Functions

References

BaseMockApplication

EggMock

MidwayApplicationOptions

MidwayMockApplication

MidwayMockContext

MidwaySocketIOClientOptions

MockApplication

MockClassFunctionHandler

MockOption

SocketIOWrapperClient

close

create

createApp

createBootstrap

createFunctionApp

createHttpRequest

createLightApp

createRabbitMQProducer

createSocketIOClient

createWebSocketClient

Type aliases

EggContext

MockAppConfigurationOptions

Type declaration

Optional baseDir?: string

Optional bootstrapTimeout?: number

Optional cleanLogsDir?: boolean

Optional cleanTempDir?: boolean

Optional entryFile?: string

MockClassFunctionHandler

Type declaration

Parameters

this: MidwayMockApplication

className: string

methodName: string

fnOrData: any

Returns any

MockHttpClientResult

ResultFunction

Type declaration

Parameters

Optional url: string

Optional opts: any

Returns ResultObject | string | void

Variables

Const EventEmitter

Const appMap

Const bootstrapAppSet

Const eventListeners

Const exchanges

Type declaration

Let lastAppDir

Const queues

Type declaration

Functions

close

Parameters

app: IMidwayApplication | IMidwayFramework<any, any>

Optional options: object

Optional cleanLogsDir?: boolean

Optional cleanTempDir?: boolean

Optional sleep?: number

Returns Promise<void>

Const connect

Returns Promise<object>

create

Type parameters

T: IMidwayFramework<any, U>

U

Parameters

Default value appDir: string = process.cwd()