Module utils/type-guards

Index

Functions

Functions

isAction

isAction(action: any): action is ViewerAction

Indicates if the given argument has the shape of a ViewerAction

export
Parameters
- action: any
Returns action is ViewerAction

isComponentFlyout

isComponentFlyout(item: any): item is IComponentFlyoutItem

Indicates if the given argument has the shape of an IComponentFlyoutItem

export
Parameters
- item: any
Returns item is IComponentFlyoutItem

isCoordinate

isCoordinate(coord: any): coord is [number, number]

Indicates if the given argument is a coordinate pair

export
Parameters
- coord: any
Returns coord is [number, number]

isError

isError(err: any): err is Error

Indicates if the given argument is an Error object

export
Parameters
- err: any
Returns err is Error

isInitError

isInitError(item: any): item is InitError

Indicates if the given argument is an InitError object

export
Parameters
- item: any
Returns item is InitError

isLayer

isLayer(layer: any): layer is MapLayer

Indicates if the given argument is a MapLayer object

export
Parameters
- layer: any
Returns layer is MapLayer

isMapView

isMapView(view: any): view is IMapView

Indicates if the given argument has the shape of an IMapView

export
Parameters
- view: any
Returns view is IMapView

isMenu

isMenu(item: any): item is IInlineMenu

Indicates if the given argument has the shape of an IInlineMenu

export
Parameters
- item: any
Returns item is IInlineMenu

isMenuRef

isMenuRef(item: any): item is IFlyoutMenu

Indicates if the given arguemnt has the shape of an IFlyoutMenu

export
Parameters
- item: any
Returns item is IFlyoutMenu

isModalComponentDisplayOptions

isModalComponentDisplayOptions(arg: any): arg is IModalComponentDisplayOptions

Indicates if the given argument is an IModalComponentDisplayOptions

export
Parameters
- arg: any
Returns arg is IModalComponentDisplayOptions

isModalDisplayOptions

isModalDisplayOptions(arg: any): arg is IModalDisplayOptions

Indicates if the given argument is an IModalDisplayOptions

export
Parameters
- arg: any
Returns arg is IModalDisplayOptions

isRuntimeMap

isRuntimeMap(arg: IGenericSubjectMapLayer | DeArrayifiedResult): arg is RuntimeMap

Indicates if the given argument is a RuntimeMap

since
0.14

Parameters
- arg: IGenericSubjectMapLayer | DeArrayifiedResult
Returns arg is RuntimeMap

Generated using TypeDoc