Merge dependabot/npm_and_yarn/examples/typescript/websocket-server-pool/ws-cluster...

[poolifier.git] / src / worker / utils.ts

import { isPlainObject } from '../utils'
import type { TaskFunction } from './task-functions'
import { KillBehaviors, type WorkerOptions } from './worker-options'

export const checkValidWorkerOptions = (opts: WorkerOptions): void => {
  if (opts != null && !isPlainObject(opts)) {
    throw new TypeError('opts worker options parameter is not a plain object')
  }
  if (
    opts?.killBehavior != null &&
    !Object.values(KillBehaviors).includes(opts.killBehavior)
  ) {
    throw new TypeError(
      `killBehavior option '${opts.killBehavior}' is not valid`
    )
  }
  if (
    opts?.maxInactiveTime != null &&
    !Number.isSafeInteger(opts.maxInactiveTime)
  ) {
    throw new TypeError('maxInactiveTime option is not an integer')
  }
  if (opts?.maxInactiveTime != null && opts.maxInactiveTime < 5) {
    throw new TypeError(
      'maxInactiveTime option is not a positive integer greater or equal than 5'
    )
  }
  if (opts?.killHandler != null && typeof opts.killHandler !== 'function') {
    throw new TypeError('killHandler option is not a function')
  }
  if (opts?.async != null) {
    throw new Error('async option is deprecated')
  }
}

export const checkValidTaskFunctionEntry = <Data = unknown, Response = unknown>(
  name: string,
  fn: TaskFunction<Data, Response>
): void => {
  if (typeof name !== 'string') {
    throw new TypeError('A taskFunctions parameter object key is not a string')
  }
  if (typeof name === 'string' && name.trim().length === 0) {
    throw new TypeError(
      'A taskFunctions parameter object key is an empty string'
    )
  }
  if (typeof fn !== 'function') {
    throw new TypeError(
      'A taskFunctions parameter object value is not a function'
    )
  }
}

export const checkTaskFunctionName = (name: string): void => {
  if (typeof name !== 'string') {
    throw new TypeError('name parameter is not a string')
  }
  if (typeof name === 'string' && name.trim().length === 0) {
    throw new TypeError('name parameter is an empty string')
  }
}