# Function: shakeEffect() (/pixi-vn/index/namespaces/effects/functions/shakeEffect)



\> **shakeEffect**(`alias`, `options?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-effect.ts:98](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-effect.ts#L98)

Shake the canvas element.
If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

## Parameters [#parameters]

### alias [#alias]

`string`

The alias to identify the component.

### options? [#options]

[`ShakeEffectProps`](/pixi-vn/index/interfaces/ShakeEffectProps) = `{}`

Animation options, matching the `options` of animate function.

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the PixiJS ticker. This parameter sets the ticker's priority.

## Returns [#returns]

`Promise`\<`string`\[] | `undefined`>