---
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

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `callback` | `SleepStatusListener` | Yes | State callback |

### Return Value

None


### Referenced Types

##### `type` SleepStatusListener

```typescript
export type SleepStatusListener = (args: SleepStatusChangeEvent) => void;
```


### Examples

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