# ArgDescription interface · @imqueue/rpc

Source: https://imqueue.org/api/rpc/latest/rpc.argdescription/
Published: 2026-08-04
Author: @imqueue maintainers (https://github.com/imqueue)
Package: @imqueue/rpc 3.5.3 — generated reference, not hand-written

Description of one argument of an exposed method, as parsed from its JSDoc.

**Signature:**

```typescript
export interface ArgDescription 
```

## Properties


| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [description](https://imqueue.org/api/rpc/latest/rpc.argdescription.description/) |  | string | Prose describing the argument, taken from the text after the name on the JSDoc `@param` line. Empty string when undocumented. |
| [isOptional](https://imqueue.org/api/rpc/latest/rpc.argdescription.isoptional/) |  | boolean | Whether the argument was documented as optional, i.e. written `[name]` in the JSDoc. A TypeScript `?` or a default value alone does not set this. |
| [name](https://imqueue.org/api/rpc/latest/rpc.argdescription.name/) |  | string | Parameter name, from the JSDoc `@param` when documented, otherwise read from the method's own signature. |
| [tsType](https://imqueue.org/api/rpc/latest/rpc.argdescription.tstype/) |  | string | The argument's type as written in the method's JSDoc, defaulting to `'any'` when undocumented. This is what a generated client emits into the method signature. Never empty. |
| [type](https://imqueue.org/api/rpc/latest/rpc.argdescription.type/) |  | string | Legacy duplicate of [ArgDescription.tsType](https://imqueue.org/api/rpc/latest/rpc.argdescription.tstype/) — always the identical string. |