Module Helper

Type declaration

• consoleEnd: string

• consoleGreen: string

• atob:function

  • atob(target: string): string

  • Parameters

    • target: string

      binary string to be encoded

    Returns string

    b64 encoding of target

• btoa:function

  • btoa(target: string): string

  • Parameters

    • target: string

      b64 string to be encoded

    Returns string

    binary encoding of target

• canAccessHPC:function

  • canAccessHPC(user: string, hpc: string): boolean

  • Parameters

    • user: string

      the user to check for

    • hpc: string

      the HPC to check for

    Returns boolean

    whether or not the user can check the HPC

• generateId:function

  • generateId(): string

  • Returns string

    random 5 digit ID

• isAllowlisted:function

  • isAllowlisted(host: string): boolean

  • Parameters

    • host: string

      JupyterHub submitting jobs

    Returns boolean

    bool, whether or not the Jupyter can submit

• isObjectEmpty:function

  • isObjectEmpty(obj: any): boolean

  • Parameters

    • obj: any

      object to check

    Returns boolean

    whether or not that object is empty

• job2object:function

  • job2object(job: Job | Job[], exclude?: any[]): Object | Object[]

  • Parameters

    • job: Job | Job[]

      list of attributes of a job

    • exclude: any[] = []

      list of attributes to exclude

    Returns Object | Object[]

    job object including all attributes in the job list and excluding fields specified in exclude

• randomStr:function

  • randomStr(length: any): string

  • Parameters

    • length: any

      desired length of the return string

    Returns string

    random string of length length