iniquity

A re-imagining of the iconic BBS software.

View on GitHub

Module: runtime/decorators

Module Decorators

Summary

Decorators for class-based BBS modules

Table of contents

Enumerations

Interfaces

Functions

Functions

IQModule

IQModule(options): (constructor: Function) => void

IQModule

decorator Marks a class as an Iniquity module and stores configuration

Parameters

Name Type
options IQModuleOptions

Returns

fn

▸ (constructor): void

Parameters
Name Type
constructor Function
Returns

void

Defined in

core/src/decorators.ts:49


IQModuleRuntime

IQModuleRuntime(options?): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor

IQModule Runtime

decorator Marks a method as the runtime entry point for a module

Parameters

Name Type
options? IQModuleRuntimeOptions

Returns

fn

▸ (target, propertyKey, descriptor): PropertyDescriptor

Parameters
Name Type
target any
propertyKey string
descriptor PropertyDescriptor
Returns

PropertyDescriptor

Defined in

core/src/decorators.ts:85


getModuleMetadata

getModuleMetadata(constructor): IQModuleOptions | undefined

Get module metadata for a constructor

Parameters

Name Type
constructor Function

Returns

IQModuleOptions | undefined

Defined in

core/src/decorators.ts:120


getRuntimeMetadata

getRuntimeMetadata(method): IQModuleRuntimeOptions | undefined

Get runtime metadata for a method

Parameters

Name Type
method Function

Returns

IQModuleRuntimeOptions | undefined

Defined in

core/src/decorators.ts:127