transformers/src/index.d
Index
Type aliases
Variables
Functions
- compatibleTransformers
- isKnownTransformer
- loadTransformer
- runTransformer
- toTransformer
- validateTransformerChain
Type aliases
Observable
Ƭ Observable: Observable‹T›
OperatorFunction
Ƭ OperatorFunction: OperatorFunction‹T, U›
Report
Ƭ Report: Report
TransformFunction
Ƭ TransformFunction: function
Type declaration:
▸ (opts?: any): OperatorFunction‹T, U›
Parameters:
| Name | Type |
|---|---|
opts? | any |
TransformOptions
Ƭ TransformOptions: object
Type declaration:
beginWith: string
defaultTransformer: string
defaultTransformerConfig: any
endWith: string
TransformerConfig
Ƭ TransformerConfig: object
Type declaration:
config: any
id: string
TransformerMeta
Ƭ TransformerMeta: object
Type declaration:
alias? : string[]
defaults? : any
description? : string
id: string
input? : string[]
output: string
Variables
Const builtinTransformerIds
• builtinTransformerIds: Readonly‹string[]›
type {Readonly<string[]>}
Functions
compatibleTransformers
▸ compatibleTransformers(sourceType: string): string[]
Parameters:
| Name | Type |
|---|---|
sourceType | string |
Returns: string[]
isKnownTransformer
▸ isKnownTransformer(id: string): boolean
Parameters:
| Name | Type |
|---|---|
id | string |
Returns: boolean
loadTransformer
▸ loadTransformer(id: string, config?: any): Transformer‹any, any›
Parameters:
| Name | Type |
|---|---|
id | string |
config? | any |
Returns: Transformer‹any, any›
runTransformer
▸ runTransformer(source: Observable‹any›): function
Parameters:
| Name | Type |
|---|---|
source | Observable‹any› |
Returns: function
▸ (observable: Observable‹Transformer‹any, any››): Observable‹unknown›
Parameters:
| Name | Type |
|---|---|
observable | Observable‹Transformer‹any, any›› |
toTransformer
▸ toTransformer(): OperatorFunction‹object, Transformer‹any, any››
Returns: OperatorFunction‹object, Transformer‹any, any››
validateTransformerChain
▸ validateTransformerChain(__namedParameters?: object): OperatorFunction‹Transformer‹any, any›, Transformer‹any, any››
Parameters:
▪Optional __namedParameters: object
| Name | Type |
|---|---|
beginWith | string |
defaultTransformer | string |
defaultTransformerConfig | any |
endWith | string |
Returns: OperatorFunction‹Transformer‹any, any›, Transformer‹any, any››