refactor: Enable jsdoc/tag-lines and jsdoc/sort-tags rules

This commit is contained in:
Joachim Van Herwegen
2024-03-14 09:29:56 +01:00
parent 3e59aa4b55
commit 65bf2bd34e
89 changed files with 276 additions and 18 deletions

View File

@@ -203,6 +203,7 @@ export class AppRunner {
/**
* Retrieves settings from package.json or configuration file when
* part of an npm project.
*
* @returns The settings defined in the configuration file
*/
public async getPackageSettings(): Promise<undefined | Record<string, unknown>> {

View File

@@ -14,6 +14,7 @@ import { Initializer } from './Initializer';
* Part of the dynamic pod creation.
* Reads the contents from the configuration storage, uses those values to instantiate ResourceStores,
* and then adds them to the routing storage.
*
* @see {@link ConfigPodManager}, {@link TemplatedPodGenerator}, {@link BaseUrlRouterRule}
*/
export class ConfigPodInitializer extends Initializer {

View File

@@ -18,7 +18,9 @@ enum ClusterMode {
/**
* Convert workers amount to {@link ClusterMode}
*
* @param workers - Amount of workers
*
* @returns ClusterMode enum value
*/
function toClusterMode(workers: number): ClusterMode {
@@ -92,6 +94,7 @@ export class ClusterManager {
/**
* Check whether the CSS server was booted in single threaded mode.
*
* @returns True is single threaded.
*/
public isSingleThreaded(): boolean {
@@ -100,6 +103,7 @@ export class ClusterManager {
/**
* Whether the calling process is the primary process.
*
* @returns True if primary
*/
public isPrimary(): boolean {
@@ -108,6 +112,7 @@ export class ClusterManager {
/**
* Whether the calling process is a worker process.
*
* @returns True if worker
*/
public isWorker(): boolean {

View File

@@ -11,8 +11,10 @@ export interface SingleThreaded {}
/**
* Convert an exported interface name to the properly expected Components.js type URI.
*
* @param componentsManager - The currently used ComponentsManager
* @param interfaceName - An interface name
*
* @returns A Components.js type URI
*/
export async function toComponentsJsType<T>(componentsManager: ComponentsManager<T>, interfaceName: string):
@@ -38,6 +40,7 @@ Promise<string> {
/**
* Will list class names of components instantiated implementing the {@link SingleThreaded}
* interface while the application is being run in multithreaded mode.
*
* @param componentsManager - The componentsManager being used to set up the application
*/
export async function listSingleThreadedComponents<T>(componentsManager: ComponentsManager<T>): Promise<string[]> {