---
name: "isSleep"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "isSleep - Check if lock is in sleep state."
summary: "Check if lock is in sleep state."
---

## isSleep

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

### Description

Whether currently in sleep mode

### Parameters

None


### Return Value

None


### Examples

#### Example

```ts
import { isSleep } from '@ray-js/lock-sdk';
const sleeping = isSleep();
```