> ## Documentation Index
> Fetch the complete documentation index at: https://docs.erna.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# timeOff

```ts theme={null}
function timeOff(opts): TimeOffRuleEntry;
```

Blocks assignments during scoped unavailable periods, mandatory by default and
degradable with LOW, MEDIUM, or HIGH priority.

## Parameters

<ResponseField name="opts" required>
  [`TimeOffOptions`](./TimeOffOptions)
</ResponseField>

## Returns

```ts theme={null}
TimeOffRuleEntry
```

Requires at least one date or recurrence scope: `dayOfWeek`, `dateRange`,
`dates`, or `recurringPeriods`. Use `from`/`until` to narrow the blocked
portion of those scoped days.