Opensearch dashboards.httpservicesetup.registerroutehandlercontext

Home > opensearch-dashboards > HttpServiceSetup > registerRouteHandlerContext

HttpServiceSetup.registerRouteHandlerContext property

Register a context provider for a route handler.

Signature:

registerRouteHandlerContext: <T extends keyof RequestHandlerContext>(contextName: T, provider: RequestHandlerContextProvider<T>) => RequestHandlerContextContainer;

Example

 // my-plugin.ts
 deps.http.registerRouteHandlerContext(
   'myApp',
   (context, req) => {
    async function search (id: string) {
      return await context.opensearch.client.asCurrentUser.find(id);
    }
    return { search };
   }
 );

// my-route-handler.ts
 router.get({ path: '/', validate: false }, async (context, req, res) => {
   const response = await context.myApp.search(...);
   return res.ok(response);
 });