Function: Enumerable()

Enumerable(value): (target, key) => void

Defined in: packages/http-framework/src/lib/decorators/Enumerable.ts:24 Decorator that sets the enumerable property of a class field to the given value.

Parameters

value

boolean Whether the property should be enumerable or not.

Returns

A property decorator. (target, key) => void

Remarks

The decorator installs a setter on the prototype, which is bypassed by the Object.defineProperty call that useDefineForClassFields (enabled by @sapphire/ts-config, and the default from ES2022 onwards) emits for class fields. Mark the field as declare so no field definition is emitted, and assign it in the constructor.

Example

import { Command, Enumerable } from '@wolfstar/http-framework';

export class UserCommand extends Command {
	(at)Enumerable(false)
	declare public cache: Map<string, string>;

	public constructor(context: Command.LoaderContext, options: Command.Options) {
		super(context, options);
		this.cache = new Map();
	}
}

Infrastructure

Shared pieces

Platform helpers

Plugins

Parameters

value

Returns

Remarks

Example

​Parameters

​value

​Returns

​Remarks

​Example

Parameters

value

Returns

Remarks

Example