register.d.ts — fastify Source File

Q: What functions are defined in register.d.ts?

register.d.ts defines 2 function(s): instance, value.

Q: What does register.d.ts depend on?

register.d.ts imports 5 module(s): ./instance, ./logger, ./plugin, ./utils, fastify.js.

Q: Where is register.d.ts in the architecture?

register.d.ts is located at types/register.d.ts (domain: CoreKernel, subdomain: LifecycleManager, directory: types).

Architecture documentation for register.d.ts, a typescript file in the fastify codebase. 5 imports, 0 dependents.

File typescript CoreKernel LifecycleManager 5 imports 2 functions

Entity Profile

CoreKernel→ LifecycleManager→ register.d.ts — fastify Source File

Dependency Diagram

graph LR
  802eb898_f6ad_4583_6b1c_62c890e86698["register.d.ts"]
  ef0b4019_4e15_bb8c_0e07_0575207a4dcc["./plugin"]
  802eb898_f6ad_4583_6b1c_62c890e86698 --> ef0b4019_4e15_bb8c_0e07_0575207a4dcc
  ee998eba_0ed8_8b67_66d6_d2f80d980a41["./logger"]
  802eb898_f6ad_4583_6b1c_62c890e86698 --> ee998eba_0ed8_8b67_66d6_d2f80d980a41
  531c9fc1_aab6_113a_24da_d449700fa629["./instance"]
  802eb898_f6ad_4583_6b1c_62c890e86698 --> 531c9fc1_aab6_113a_24da_d449700fa629
  36d8862b_caf4_88a2_ba4d_4f7ed0738291["./utils"]
  802eb898_f6ad_4583_6b1c_62c890e86698 --> 36d8862b_caf4_88a2_ba4d_4f7ed0738291
  2bf9986b_b7fb_0c78_f075_72fbe6f4672b["fastify.js"]
  802eb898_f6ad_4583_6b1c_62c890e86698 --> 2bf9986b_b7fb_0c78_f075_72fbe6f4672b
  style 802eb898_f6ad_4583_6b1c_62c890e86698 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { FastifyPluginOptions, FastifyPluginCallback, FastifyPluginAsync } from './plugin'
import { LogLevel } from './logger'
import { FastifyInstance } from './instance'
import { RawServerBase } from './utils'
import { FastifyBaseLogger, FastifyTypeProvider, RawServerDefault } from '../fastify'

export interface RegisterOptions {
  prefix?: string;
  logLevel?: LogLevel;
  logSerializers?: Record<string, (value: any) => string>;
}

export type FastifyRegisterOptions<Options> = (RegisterOptions & Options) | ((instance: FastifyInstance) => RegisterOptions & Options)

/**
 * FastifyRegister
 *
 * Function for adding a plugin to fastify. The options are inferred from the passed in FastifyPlugin parameter.
 */
export interface FastifyRegister<T = void, RawServer extends RawServerBase = RawServerDefault, TypeProviderDefault extends FastifyTypeProvider = FastifyTypeProvider, LoggerDefault extends FastifyBaseLogger = FastifyBaseLogger> {
  <Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
    plugin: FastifyPluginCallback<FastifyPluginOptions, Server, TypeProvider, Logger>
  ): T;
  <Options extends FastifyPluginOptions, Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
    plugin: FastifyPluginCallback<Options, Server, TypeProvider, Logger>,
    opts: FastifyRegisterOptions<Options>
  ): T;
  <Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
    plugin: FastifyPluginAsync<FastifyPluginOptions, Server, TypeProvider, Logger>
  ): T;
  <Options extends FastifyPluginOptions, Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
    plugin: FastifyPluginAsync<Options, Server, TypeProvider, Logger>,
    opts: FastifyRegisterOptions<Options>
  ): T;
  <Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
    plugin: FastifyPluginCallback<FastifyPluginOptions, Server, TypeProvider, Logger> | FastifyPluginAsync<FastifyPluginOptions, Server, TypeProvider, Logger> | Promise<{ default: FastifyPluginCallback<FastifyPluginOptions, Server, TypeProvider, Logger> }> | Promise<{ default: FastifyPluginAsync<FastifyPluginOptions, Server, TypeProvider, Logger> }>,
  ): T;
  <Options extends FastifyPluginOptions, Server extends RawServerBase = RawServer, TypeProvider extends FastifyTypeProvider = TypeProviderDefault, Logger extends FastifyBaseLogger = LoggerDefault>(
    plugin: FastifyPluginCallback<Options, Server, TypeProvider, Logger> | FastifyPluginAsync<Options, Server, TypeProvider, Logger> | Promise<{ default: FastifyPluginCallback<Options, Server, TypeProvider, Logger> }> | Promise<{ default: FastifyPluginAsync<Options, Server, TypeProvider, Logger> }>,
    opts: FastifyRegisterOptions<Options>
  ): T;
}