# isSecretProp

Canonical: https://docs.shumoku.dev/en/library/api/isSecretProp
Language: en

@shumoku/core · 0.4.0 · function

# isSecretProp

[Source](https://github.com/konoe-akitoshi/shumoku/blob/main/libs/@shumoku/core/src/plugin-kit/secrets.ts#L22)

A field is a write-only secret if it declares \`secret: true\`. \`format: 'password'\` is honoured too so external plugins that predate the flag keep working; new schemas should set \`secret: true\`.

```
isSecretProp(prop: PluginConfigProperty): boolean
```

## Parameters

| Parameter | Type | Description | Default |
| --- | --- | --- | --- |
| `prop` | `PluginConfigProperty` | No additional description. | `—` |

## Returns

```
boolean
```

[`libs/@shumoku/core/src/plugin-kit/secrets.ts:22`](https://github.com/konoe-akitoshi/shumoku/blob/main/libs/@shumoku/core/src/plugin-kit/secrets.ts#L22)