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



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

Defined in: [src/canvas/functions/canvas-effect.ts:13](https://github.com/DRincs-Productions/pixi-vn/blob/92a10d7481511296d22e17c43fbc1d4dd976bef8/src/canvas/functions/canvas-effect.ts#L13)

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`](/jsdoc/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`>