Skip to main content Link Search Menu Expand Document (external link)

Service overview

Added in v0.1.0


Table of contents


constructors

fromClientAndCommands

Signature

export declare const fromClientAndCommands: <Service>(
  client: Client<any, any, BaseResolvedConfig>,
  commands: Record<string, CommandCtor<any>>,
  options: ServiceFnOptions,
  paginators?: Record<string, PaginatorCtor<any>>
) => Effect.Effect<Service>

Added in v0.1.0

fromCommandsAndServiceFn

Signature

export declare const fromCommandsAndServiceFn: <Service>(
  commands: Record<string, CommandCtor<any>>,
  serviceFnMaker: (CommandCtor: CommandCtor<any>) => ReturnType<typeof makeServiceFn>,
  paginators?: Record<string, PaginatorCtor<any>>,
  streamFnMaker?: (paginateFn: PaginatorCtor<any>) => ReturnType<typeof makeServiceStreamFn>
) => Effect.Effect<Service>

Added in v0.1.0

makeServiceFn

Signature

export declare const makeServiceFn: (
  client: Client<any, any, BaseResolvedConfig>,
  CommandCtor: CommandCtor<any>,
  fnOptions: ServiceFnOptions
) => (args: any, options?: HttpHandlerOptions) => Effect.Effect<any, unknown, never>

Added in v0.1.0

makeServiceStreamFn

Signature

export declare const makeServiceStreamFn: (
  client: Client<any, any, BaseResolvedConfig>,
  paginateFn: PaginatorCtor<any>,
  fnOptions: ServiceFnOptions
) => (args: any, options?: HttpHandlerOptions) => Stream.Stream<any, unknown, never>

Added in v0.4.0

errors

catchServiceExceptions

Signature

export declare const catchServiceExceptions: (
  errorTags?: Array.NonEmptyReadonlyArray<string>
) => (e: unknown) => unknown

Added in v0.1.0

models

BaseResolvedConfig (interface)

Signature

export interface BaseResolvedConfig
  extends Required<LoggerResolvedConfig>,
    SmithyResolvedConfiguration<HandlerOptions> {
  requestHandler: RequestHandler<any, any, any>
}

Added in v0.3.0

CommandCtor (type alias)

Signature

export type CommandCtor<I> = new (input: I, ...args: Array<any>) => CommandImpl<I, any, BaseResolvedConfig>

Added in v0.3.0

LoggerResolvedConfig (interface)

Signature

export interface LoggerResolvedConfig {
  logger?: Logger
}

Added in v0.3.0

PaginatorCtor (type alias)

Signature

export type PaginatorCtor<I> = (config: PaginationConfiguration, input: I, ...args: Array<any>) => Paginator<any>

Added in v0.4.0