---
name: "disableRule"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.7.60" }
title: "disableRule - 关闭已绑定规则"
---

## disableRule

> [VERSION] @ray-js/ray >= 1.7.60

### Description

Disable bound rules to pause automatic execution

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `IRuleIdParams` | Yes | Parameters for disabling rules |

### Return Value

Type: `Promise<boolean>`

Whether the operation succeeded

### Referenced Types

##### `interface` IRuleIdParams

| Property | Type | Description |
| --- | --- | --- |
| `ruleId` | `string` | Rule ID |


### Examples

```typescript
import { disableRule } from '@ray-js/ray';

const disableSceneRule = async () => {
  try {
    const success = await disableRule({
      ruleId: 'rule_001',
    });
    console.log('Disable rule result:', success);
  } catch (err) {
    console.error('Disable failed:', err);
  }
};
```