jimpex
    Preparing search index...

    Variable utilsServicesProviderConst

    utilsServicesProvider: {
        ensureBearerTokenProvider: ResourceCreator<
            "provider",
            "register",
            (options?: EnsureBearerTokenProviderOptions) => (app: Jimpex) => void,
            ProviderRegisterFn<Jimpex>,
        >;
    } & Record<
        string,
        Resource<"provider", "register", ProviderRegisterFn<Jimpex>>,
    > & { provider: true } & { register: ProviderRegisterFn<Jimpex> } & Record<
        string,
        unknown,
    > = ...

    Registers all the utility services on the container.

    Type Declaration

    • ensureBearerTokenProvider: ResourceCreator<
          "provider",
          "register",
          (options?: EnsureBearerTokenProviderOptions) => (app: Jimpex) => void,
          ProviderRegisterFn<Jimpex>,
      >

      Generates a "service middleware" that can be used on route controllers in order to validate the presence of a bearer token on the requests authorization header.

      The registered service is an instance of EnsureBearerToken, and it uses the key ensureBearerToken.

      Since it's a "provider creator", when registering it, you can pass custom options.

        // Register it on the container
      container.register(ensureBearerTokenProvider);

      // Let's assume we are in a controller now...
      // Getting access to the middleware.
      const ensureBearerToken = container.get<ExpressMiddleware>('ensureBearerToken');
        // Register it on the container
      container.register(
      ensureBearerTokenProvider({
      serviceName: 'ensureBearerTokenCustom',
      error: {
      message: 'Missing token!',
      },
      }),
      );
    • provider: true
    • register: ProviderRegisterFn<Jimpex>
    // Register the collection on the container
    container.register(utilsServicesProvider);
    // Getting access to one the services instance
    const ensureBearerToken = container.get<EnsureBearerToken>('ensureBearerToken');