Module flattened

Index

Classes

FlattenedClass

Functions

Functions

flattenedCallback

flattenedCallback(callback: (param: number, optionalParam?: string) => string): void

A function that has a parameter that requires a typed function callback.

Parameters
- callback: (param: number, optionalParam?: string) => string
  
  The typed function callback.
  - - (param: number, optionalParam?: string): string
    - Parameters
      - param: number
        
        A parameter of the typed function callback.
      - Optional optionalParam: string
        
        An optional parameter of the typed function callback.
      Returns string
Returns void

flattenedIndexSignature

flattenedIndexSignature(indexed: { test: string }): void

A function that accepts an index signature parameter.

Parameters
- indexed: { test: string }
  
  The index signature parameter.
  - [index: number]: { name: string; value?: number }
    - name: string
    - Optional value?: number
  - test: string
    
    A property of the index signature instance.
Returns void

flattenedParameter

flattenedParameter(options: { anotherValue?: string; moreOptions?: { moreValues: number }; value?: string }): void

A function that accepts an option object defined inline.

Parameters
- options: { anotherValue?: string; moreOptions?: { moreValues: number }; value?: string }
  
  The inline typed options object.
  - [name: string]: any
  - Optional anotherValue?: string
    
    Another value on the options object parameter.
  - Optional moreOptions?: { moreValues: number }
    
    A typed child object of the options object.
    - moreValues: number
  - Optional value?: string
    
    A value on the options object parameter.
Returns void

Generated using TypeDoc