property() function

Marks a class field as part of an exposed complex type, so it is described to clients and appears in the generated client interfaces.

Signature:

export declare function property(type: string | Thunk | any, isOptional?: boolean): any;

Parameters

Parameter	Type	Description
type	string \| Thunk \| any	the field's RPC type: a type-definition string (`'string'`, `'Address'`, `'Array<Address>'`), a constructor (its `name` is used), a single-element array such as `[Address]` (which yields `Address[]`), or an anonymous Thunk returning any of those — required for self- or forward-referencing types, since a thunk is not invoked until the description is first read. A named function is treated as a constructor, not a thunk.
isOptional	boolean	(Optional) marks the field optional in the generated type. Not inferred from the TypeScript `?` modifier — pass `true` explicitly.

Returns:

any

a dual-mode field decorator (target, context) => any, typed any so one function serves both decorator protocols. Under standard (TC39) decorators it records the field on the class's decorator metadata for a later flush and returns undefined; under legacy decorators it writes the field into the RPC type description immediately.

Remarks

Every class that uses @property must also carry a class-level classType() — or indexed(), which does the same flush — when compiling with standard (TC39) decorators, the protocol this package targets. Standard field decorators cannot see their class, so a class-level decorator is what registers the collected fields under the class name. Omitting it fails silently: the type simply never appears in the RPC type description, and generated clients reference an undeclared type.

Passing a falsy type returns undefined, which TypeScript accepts as a no-op decoration — the field is then silently absent from the type description.

Example

import { classType, property, expose, IMQService } from '@imqueue/rpc';

// every class using @property also needs a class-level @classType()
@classType()
class Address {
    @property('string')
    country!: string;

    @property('string', true)
    zipCode?: string; // optional
}

@classType()
class User {
    @property('string')
    firstName!: string;

    // thunk + array form, for a forward reference
    @property(() => [Address], true)
    addresses?: Address[];
}

class UserService extends IMQService {
    // exposed methods need a JSDoc block with typed @param/@returns tags —
    // see the `expose` decorator
    @expose()
    public async save(user: User): Promise<boolean> {
        return true;
    }
}

Read this page as plain markdown — no HTML, no navigation. For pasting into an LLM, or for an agent to fetch.