---
name: "onSleepStatusChange"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "onSleepStatusChange - Register sleep status change event."
summary: "Register sleep status change event."
---

## onSleepStatusChange

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### Description

Register sleep-state change event

### Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `callback` | `(args: SleepStatusChangeEvent) => void` | Yes | State callback |

##### SleepStatusChangeEvent properties

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `sleep` | `boolean` | Yes | - | Whether sleeping |


### Return Value

None


### Examples

#### Example

```ts
import { onSleepStatusChange } from '@ray-js/lock-sdk';
onSleepStatusChange((args) => {
  console.log(args.sleep);
});
```