node-nlp
Version:
Library for NLU (Natural Language Understanding) done in Node.js
97 lines (96 loc) • 3.3 kB
TypeScript
/**
* @module botbuilder
*/
/**
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License.
*/
import { TurnContext } from './turnContext';
/**
* Interface implemented by object based middleware.
*/
export interface Middleware {
/**
* Called each time the bot receives a new request.
*
* @remarks
* Calling `await next();` will cause execution to continue to either the next piece of
* middleware in the chain or the bots main logic if you are the last piece of middleware.
*
* Your middleware should perform its business logic before and/or after the call to `next()`.
* You can short-circuit further execution of the turn by omitting the call to `next()`.
*
* The following example shows a simple piece of logging middleware:
*
* ```JavaScript
* class MyLogger {
* async onTurn(context, next) {
* console.log(`Leading Edge`);
* await next();
* console.log(`Trailing Edge`);
* }
* }
* ```
* @param context Context for current turn of conversation with the user.
* @param next Function to call to continue execution to the next step in the middleware chain.
*/
onTurn(context: TurnContext, next: () => Promise<void>): Promise<void>;
}
/**
* Signature implemented by function based middleware.
*
* ```TypeScript
* type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
* ```
*/
export declare type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
/**
* A set of `Middleware` plugins.
*
* @remarks
* The set itself is middleware so you can easily package up a set of middleware that can be composed
* into an adapter with a single `adapter.use(mySet)` call or even into another middleware set using
* `set.use(mySet)`.
*
* ```JavaScript
* const { MiddlewareSet } = require('botbuilder');
*
* const set = new MiddlewareSet();
* set.use(async (context, next) => {
* console.log(`Leading Edge`);
* await next();
* console.log(`Trailing Edge`);
* });
* ```
*/
export declare class MiddlewareSet implements Middleware {
private middleware;
/**
* Creates a new MiddlewareSet instance.
* @param middleware One or more middleware handlers(s) to register.
*/
constructor(...middleware: (MiddlewareHandler | Middleware)[]);
onTurn(context: TurnContext, next: () => Promise<void>): Promise<void>;
/**
* Registers middleware handlers(s) with the set.
*
* @remarks
* This example adds a new piece of middleware to a set:
*
* ```JavaScript
* set.use(async (context, next) => {
* console.log(`Leading Edge`);
* await next();
* console.log(`Trailing Edge`);
* });
* ```
* @param middleware One or more middleware handlers(s) to register.
*/
use(...middleware: (MiddlewareHandler | Middleware)[]): this;
/**
* Executes a set of middleware in series.
* @param context Context for the current turn of conversation with the user.
* @param next Function to invoke at the end of the middleware chain.
*/
run(context: TurnContext, next: () => Promise<void>): Promise<void>;
}