Skip to content

Latest commit

 

History

History
99 lines (57 loc) · 2.63 KB

modifiers_types.Modifier.md

File metadata and controls

99 lines (57 loc) · 2.63 KB

@interactjs / modifiers/types / Modifier

Interface: Modifier<Defaults, State, Name, Result>

modifiers/types.Modifier

Type parameters

Name Type
Defaults any
State extends ModifierState = any
Name extends string = any
Result any

Table of contents

Properties

Properties

disable

disable: () => Modifier<Defaults, State, Name, Result>

Type declaration

▸ (): Modifier<Defaults, State, Name, Result>

Returns

Modifier<Defaults, State, Name, Result>

Defined in

modifiers/types.ts:21


enable

enable: () => Modifier<Defaults, State, Name, Result>

Type declaration

▸ (): Modifier<Defaults, State, Name, Result>

Returns

Modifier<Defaults, State, Name, Result>

Defined in

modifiers/types.ts:20


methods

methods: Object

Type declaration

Name Type
beforeEnd? (arg: ModifierArg<State>) => void | Point
set? (arg: ModifierArg<State>) => Result
start? (arg: ModifierArg<State>) => void
stop? (arg: ModifierArg<State>) => void

Defined in

modifiers/types.ts:13


name

Optional name: Name

Defined in

modifiers/types.ts:19


options

options: Defaults

Defined in

modifiers/types.ts:12