kaven-utils
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

BackupMongoDB

  • BackupMongoDB(outputDir: string, databaseName?: string, host?: string, databaseUser?: string, databasePassword?: string): Promise<string>
  • version

    1.0.1

    since

    1.0.5

    Parameters

    • outputDir: string
    • Optional databaseName: string
    • host: string = "127.0.0.1:27017"
    • Optional databaseUser: string
    • Optional databasePassword: string

    Returns Promise<string>

Base64Decode

  • Base64Decode(base64Data: string, encoding?: BufferEncoding): string

Base64Encode

  • Base64Encode(data: string, encoding?: BufferEncoding): string

BuildError

  • BuildError(...param: any[]): string
  • since

    1.1.7

    version

    2018-09-01

    Parameters

    • Rest ...param: any[]

    Returns string

BuildLogString

  • BuildLogString(level?: LogLevel, ...args: any[]): string
  • version

    1.0.0

    since

    1.0.5

    Parameters

    • level: LogLevel = ...
    • Rest ...args: any[]

    Returns string

CreateCertificate

  • CreateCertificate(options?: CertificateCreationOptions): Promise<CertificateCreationResult>

CreateJWT

  • CreateJWT(payload: string | object | Buffer, secret: string, options: JWT.SignOptions): Promise<undefined | string>
  • version

    1.1.17

    since

    2018-10-19

    Parameters

    • payload: string | object | Buffer
    • secret: string
    • options: JWT.SignOptions

    Returns Promise<undefined | string>

DecodeJWT

  • DecodeJWT(token: string, options?: JWT.DecodeOptions): null | string | JwtPayload

  • Warning: This will not verify whether the signature is valid.

    version

    1.1.17

    since

    2018-10-19

    Parameters

    • token: string
    • Optional options: JWT.DecodeOptions

    Returns null | string | JwtPayload

Exec

  • Exec(command: string, options?: IExecOptions, autoDecode?: boolean): ChildProcess
  • since

    1.1.21

    version

    2018-11-06

    Parameters

    • command: string
    • Optional options: IExecOptions
    • autoDecode: boolean = true

    Returns ChildProcess

FindAndReplaceInFiles

  • FindAndReplaceInFiles(dirOrFiles: string | string[], conditions?: string[][], newStrMethod?: (str: string) => string, extensions?: string[], showLog?: boolean): Promise<void>
  • static
    memberof

    KavenUtility

    since

    1.1.6

    version

    2018-09-01

    Parameters

    • dirOrFiles: string | string[]
    • conditions: string[][] = ...
    • Optional newStrMethod: (str: string) => string
        • (str: string): string

        • Parameters

          • str: string

          Returns string

    • extensions: string[] = ...
    • showLog: boolean = true

    Returns Promise<void>

GenerateQRCode

  • GenerateQRCode(data: string, version?: number, errorCorrectionLevel?: "low" | "medium" | "quartile" | "high" | "L" | "M" | "Q" | "H", toSJISFunc?: (codePoint: string) => number): Promise<string>
  • version

    1.0.0

    since

    1.0.5

    see

    https://github.com/soldair/node-qrcode

    Parameters

    • data: string
    • Optional version: number
    • Optional errorCorrectionLevel: "low" | "medium" | "quartile" | "high" | "L" | "M" | "Q" | "H"
    • Optional toSJISFunc: (codePoint: string) => number
        • (codePoint: string): number

        • Helper function used internally to convert a kanji to its Shift JIS value. Provide this function if you need support for Kanji mode.

          Parameters

          • codePoint: string

          Returns number

    Returns Promise<string>

GetAllFiles

  • GetAllFiles(dir: string): string[]

  • Simple wrap for readdirSync

    version

    1.1.18

    since

    2018-10-22

    Parameters

    • dir: string

    Returns string[]

GetAllFilesRecursively

  • GetAllFilesRecursively(dir: string, extensions?: string[], ignorePaths?: string[]): string[]

  • List all files in a directory in Node.js recursively in a synchronous fashion

    see

    https://gist.github.com/kethinov/6658166

    static
    memberof

    KavenUtility

    since

    1.1.6

    version

    2018-08-27

    Parameters

    • dir: string
    • Optional extensions: string[]
    • Optional ignorePaths: string[]

    Returns string[]

GetColoredStatus

  • GetColoredStatus(code: string | number | undefined): undefined | string | number
  • version

    1.0.1

    since

    1.0.5

    Parameters

    • code: string | number | undefined

    Returns undefined | string | number

GetFileContent

  • GetFileContent(fileName: string, html?: boolean): Promise<string>
  • since

    1.0.5

    version

    2021-11-20

    Parameters

    • fileName: string
    • html: boolean = false

    Returns Promise<string>

GetFileLines

  • GetFileLines(fileName: string): Promise<ITextLines>
  • since

    3.0.1

    version

    2021-09-01

    Parameters

    • fileName: string

    Returns Promise<ITextLines>

GetFileList

  • GetFileList(filesOrFolders: string[], excludeFilesOrFolders?: string[], fileTypes?: string[]): string[]
  • since

    1.1.7

    version

    2018-09-01

    Parameters

    • filesOrFolders: string[]
    • Optional excludeFilesOrFolders: string[]
    • Optional fileTypes: string[]

    Returns string[]

GetFileType

  • GetFileType(buf: Buffer | Uint8Array): Promise<FileTypeResult | undefined>
  • since

    1.1.7

    version

    2020-01-22

    Parameters

    • buf: Buffer | Uint8Array

    Returns Promise<FileTypeResult | undefined>

GetFileTypeFromFile

  • GetFileTypeFromFile(file: string): Promise<FileTypeResult | undefined>
  • version

    1.1.18

    since

    2018-10-25

    Parameters

    • file: string

    Returns Promise<FileTypeResult | undefined>

GetProtocolFromURL

  • GetProtocolFromURL(url: string): undefined | string
  • since

    1.1.23

    version

    2019-02-27

    Parameters

    • url: string

    Returns undefined | string

HMAC_SHA1

  • HMAC_SHA1(stringToSign: string, secret: string): Buffer

  • In cryptography, an HMAC (sometimes expanded as either keyed-hash message authentication code or hash-based message authentication code) is a specific type of message authentication code (MAC) involving a cryptographic hash function and a secret cryptographic key.

    static
    memberof

    KavenUtility

    version

    2018-08-20

    since

    1.1.6

    Parameters

    • stringToSign: string
    • secret: string

    Returns Buffer

InitializeTextLogger

  • InitializeTextLogger(stdoutFile?: string, stderrFile?: string, resetSizeInBytes?: number, resetCron?: string): (() => Promise<void>) | undefined
  • since

    1.1.26

    version

    2021-11-20

    Parameters

    • Optional stdoutFile: string
    • Optional stderrFile: string
    • resetSizeInBytes: number = ...

      Default 10.00 MiB

    • resetCron: string = "*/5 * * * *"

      Default Execute every 5 Minutes

    Returns (() => Promise<void>) | undefined

LoadJsonFile

  • LoadJsonFile(filePath: string): Promise<IndexObject<any>>
  • export
    version

    1.0.1

    since

    1.0.12

    Parameters

    • filePath: string

    Returns Promise<IndexObject<any>>

ReadFileAsBase64

  • ReadFileAsBase64(file: string): Promise<unknown>

  • Parameters

    • file: string

    Returns Promise<unknown>

ReadFileBytes

  • ReadFileBytes(file: string, length: number, offset?: number): Promise<Buffer>
  • version

    1.1.18

    since

    2018-10-25

    Parameters

    • file: string
    • length: number
    • offset: number = 0

    Returns Promise<Buffer>

ResetLogFile

  • ResetLogFile(fileName: string, backupFolder?: string): Promise<boolean>

  • 2019-08-05: remove default value "./data/logs/" for backupFolder; change backup file name

    since

    1.0.5

    version

    2021-09-13

    Parameters

    • fileName: string
    • Optional backupFolder: string

    Returns Promise<boolean>

ResetLogFileIf

  • ResetLogFileIf(overBytes?: number, logFile?: string): Promise<boolean>

  • 2019-08-05: add param: logFile

    since

    1.0.9

    version

    2020-07-11

    Parameters

    • overBytes: number = ...
    • Optional logFile: string

    Returns Promise<boolean>

RunCommand

  • RunCommand(command: string, options?: { encoding: BufferEncoding } & ExecOptions): Promise<{ stderr: string | Buffer; stdout: string | Buffer }>

RunCommandAndDecode

  • RunCommandAndDecode(command: string, decodeEncoding?: string): Promise<{ stderr: string; stdout: string }>
  • since

    1.1.14

    version

    2018-10-18

    Parameters

    • command: string
    • decodeEncoding: string = "cp936"

    Returns Promise<{ stderr: string; stdout: string }>

SaveStringToFile

  • SaveStringToFile(str: string, savePath: string): Promise<string>
  • export
    version

    1.0.0

    since

    1.0.6

    Parameters

    • str: string
    • savePath: string

    Returns Promise<string>

SendEmail

  • SendEmail(config: MailConfig, option: MailOption): Promise<unknown>
  • version

    1.0.0

    since

    1.0.5

    Parameters

    Returns Promise<unknown>

Spawn

  • Spawn(command: string, args?: ReadonlyArray<string>, options?: SpawnOptionsWithoutStdio, autoDecode?: boolean): ChildProcessWithoutNullStreams
  • since

    1.1.21

    version

    2018-11-05

    Parameters

    • command: string
    • Optional args: ReadonlyArray<string>
    • Optional options: SpawnOptionsWithoutStdio
    • autoDecode: boolean = true

    Returns ChildProcessWithoutNullStreams

StartSchedule

  • StartSchedule(func: () => void, year?: number | number[], month?: number | number[], date?: number | number[], dayOfWeek?: number | number[], hour?: number | number[], minute?: number | number[], second?: number | number[]): Job

  • https://github.com/node-schedule/node-schedule

    version

    1.0.1

    since

    1.0.5

    Parameters

    • func: () => void
        • (): void

        • Returns void

    • Optional year: number | number[]
    • Optional month: number | number[]

      (0-11)

    • Optional date: number | number[]

      (1-31)

    • Optional dayOfWeek: number | number[]

      (0-6) Starting with Sunday

    • Optional hour: number | number[]

      (0-23)

    • Optional minute: number | number[]

      (0-59)

    • Optional second: number | number[]

      (0-59)

    Returns Job

StartScheduleLikeCron

  • StartScheduleLikeCron(func: () => void, rule: string): Job
  • version

    1.0.0

    since

    1.0.9

    Parameters

    • func: () => void
        • (): void

        • Returns void

    • rule: string

    Returns Job

TryParseVersionFromFile

  • TryParseVersionFromFile(file: string): Promise<undefined | { endOfLineSequence: undefined | string; lines: string[]; version: undefined | string; versionLine: string }>
  • since

    3.0.5

    version

    2021-12-07

    Parameters

    • file: string

    Returns Promise<undefined | { endOfLineSequence: undefined | string; lines: string[]; version: undefined | string; versionLine: string }>

TryUpdateVersion

  • TryUpdateVersion(file: string): Promise<string>
  • TryUpdateVersion(file: string, index: number, increment: number): Promise<string>

  • Support package.json and pubspec.yaml

    since

    3.0.5

    version

    2021-12-07

    Parameters

    • file: string

    Returns Promise<string>

  • Parameters

    • file: string
    • index: number
    • increment: number

    Returns Promise<string>

VerifyJWT

  • VerifyJWT(token: string, secret: string, options?: JWT.SignOptions): Promise<{}>
  • version

    1.1.17

    since

    2018-10-19

    Parameters

    • token: string
    • secret: string
    • Optional options: JWT.SignOptions

    Returns Promise<{}>

Legend

  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Interface
  • Interface with type parameter
  • Enumeration
  • Class

Generated using TypeDoc