---
name: "getSleepPeriod"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getSleepPeriod - Get sleep time period."
summary: "Get sleep time period."
---

## getSleepPeriod

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

### Description

Get the sleep time range

### Parameters

None


### Return Value

Type: `GetDpPeriodTimeResult`

Sleep time range

##### GetDpPeriodTimeResult

| Property | Type | Description |
| --- | --- | --- |
| `start` | `number` | Start time (minutes) |
| `end` | `number` | End time (minutes) |

### Examples

#### Example

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