is-my-file-ready

Index

Type aliases

Functions

Type aliases

CheckFunction

CheckFunction: (path: string) => Promise<CheckResult>

Type declaration

- (path: string): Promise<CheckResult>
- Parameters
  - path: string
  Returns Promise<CheckResult>

CheckName

CheckName: "editTime" | "endsWithBytes" | "endsWithStr" | "sameSize"

CheckResult

CheckResult: { isReady: boolean } & EditTimeResult | EndsWithBytesResult | EndsWithStrResult | SameSizeResult

Functions

default

default(path: string, checks: CheckFunction[] | CheckFunction): Promise<{ checks: CheckResult[]; isReady: boolean }>

- Defined in index.ts:7
Parameters
- path: string
- checks: CheckFunction[] | CheckFunction
Returns Promise<{ checks: CheckResult[]; isReady: boolean }>

true - if my file is ready

editTime

editTime(referenceTime: Date | number): CheckFunction

- Defined in checks/editTime.ts:5
Parameters
- referenceTime: Date | number
Returns CheckFunction

endsWithBytes

endsWithBytes(endBytes: ArrayLike<number>): CheckFunction

- Defined in checks/endsWithBytes.ts:5
Parameters
- endBytes: ArrayLike<number>
Returns CheckFunction

endsWithStr

endsWithStr(endsStr: string): CheckFunction

- Defined in checks/endsWithStr.ts:5
Parameters
- endsStr: string
Returns CheckFunction

sameSize

sameSize(expectedSize: number): CheckFunction

- Defined in checks/sameSize.ts:5
Parameters
- expectedSize: number
Returns CheckFunction