Node SDK

Interface RStreamsContext<R>

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Property
  • Method
  • Enumeration
  • Class

Type parameters

  • R = any

Hierarchy

  • Context
    • RStreamsContext

Index

Properties

Methods

Properties

awsRequestId

awsRequestId: string

botId

botId: string

callbackWaitsForEmptyEventLoop

callbackWaitsForEmptyEventLoop: boolean

Optional clientContext

clientContext?: ClientContext

functionName

functionName: string

functionVersion

functionVersion: string

Optional identity

identity?: CognitoIdentity

invokedFunctionArn

invokedFunctionArn: string

logGroupName

logGroupName: string

logStreamName

logStreamName: string

memoryLimitInMB

memoryLimitInMB: string

Optional resources

resources?: R

sdk

sdk: RStreamsSdk

Methods

done

  • done(error?: Error, result?: any): void
  • deprecated

    Use handler callback or promise result

    Parameters

    • Optional error: Error
    • Optional result: any

    Returns void

fail

  • fail(error: string | Error): void
  • deprecated

    Use handler callback with first argument or reject a promise result

    Parameters

    • error: string | Error

    Returns void

getCheckpoint

  • getCheckpoint(queue: string, defaultIfNull: string): Promise<string>

  • Parameters

    • queue: string
    • defaultIfNull: string

    Returns Promise<string>

getRemainingTimeInMillis

  • getRemainingTimeInMillis(): number

  • Returns number

succeed

  • succeed(messageOrObject: any): void
  • succeed(message: string, object: any): void
  • deprecated

    Use handler callback with second argument or resolve a promise result

    Parameters

    • messageOrObject: any

    Returns void

  • deprecated

    Use handler callback or promise result

    Parameters

    • message: string
    • object: any

    Returns void

Generated using TypeDoc