Class ImageCheck

Common interface implemented by all check classes.

Hierarchy (View Summary)

FileCheck
- ImageCheck

Constructors

constructor

new ImageCheck(key: string | number, data: unknown): ImageCheck
Parameters
- key: string | number
- data: unknown
Returns ImageCheck
Overrides FileCheck.constructor
- Defined in checks/image.check.ts:20

Properties

`Protected` `Optional`buffer

buffer?: Uint8Array<ArrayBufferLike>

`Protected` `Optional`type

type?: string

`Protected` `Optional`width

width?: number

`Protected` `Optional`height

height?: number

`Protected`key

key: string | number

`Protected`data

data: any

`Protected`has_value

has_value: boolean

`Protected`out

Methods

mimeType

mimeType(expectedMime: string, options?: CheckOptions): this
Parameters
- expectedMime: string
- Optionaloptions: CheckOptions
Returns this
Inherited from FileCheck.mimeType
- Defined in checks/file.check.ts:42

notEmpty

notEmpty(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
Inherited from FileCheck.notEmpty
- Defined in checks/file.check.ts:61

minSize

minSize(minBytes: number, options?: CheckOptions): this
Parameters
- minBytes: number
- Optionaloptions: CheckOptions
Returns this
Inherited from FileCheck.minSize
- Defined in checks/file.check.ts:68

maxSize

maxSize(maxBytes: number, options?: CheckOptions): this
Parameters
- maxBytes: number
- Optionaloptions: CheckOptions
Returns this
Inherited from FileCheck.maxSize
- Defined in checks/file.check.ts:77

`Protected`getSize

getSize(): number
Returns number
Inherited from FileCheck.getSize
- Defined in checks/file.check.ts:86

`Protected`spliceBuffer

spliceBuffer(start: number, end?: number): Uint8Array
Parameters
- start: number
- Optionalend: number
Returns Uint8Array
Inherited from FileCheck.spliceBuffer
- Defined in checks/file.check.ts:91

`Protected`toUint8Array

toUint8Array(
input: unknown,
maxBytes?: number,
): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- input: unknown
- maxBytes: number = Infinity
Returns Promise<Uint8Array<ArrayBufferLike>>
Inherited from FileCheck.toUint8Array
- Defined in checks/file.check.ts:96

`Protected`getMimeType

getMimeType(buffer: Uint8Array): Promise<string>
Parameters
- buffer: Uint8Array
Returns Promise<string>
Inherited from FileCheck.getMimeType
- Defined in checks/file.check.ts:134

`Static`for

for(key: string | number, data: unknown): Promise<ImageCheck>
Parameters
- key: string | number
- data: unknown
Returns Promise<ImageCheck>
Overrides FileCheck.for
- Defined in checks/image.check.ts:14

`Protected`init

init(): Promise<ImageCheck>
Returns Promise<ImageCheck>
Overrides FileCheck.init
- Defined in checks/image.check.ts:26

isImage

isImage(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/image.check.ts:37

minWidth

minWidth(minWidth: number, options?: CheckOptions): this
Parameters
- minWidth: number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/image.check.ts:50

minHeight

minHeight(minHeight: number, options?: CheckOptions): this
Parameters
- minHeight: number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/image.check.ts:63

maxWidth

maxWidth(maxWidth: number, options?: CheckOptions): this
Parameters
- maxWidth: number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/image.check.ts:76

maxHeight

maxHeight(maxHeight: number, options?: CheckOptions): this
Parameters
- maxHeight: number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/image.check.ts:89

`Protected`loadImageMetadata

loadImageMetadata(): Promise<void>
Returns Promise<void>
- Defined in checks/image.check.ts:102

`Protected`getImageDimensions

getImageDimensions(
buffer: Uint8Array,
type?: string,
): Promise<{ width: number; height: number; type: string } | null>
Parameters
- buffer: Uint8Array
- Optionaltype: string
Returns Promise<{ width: number; height: number; type: string } | null>
- Defined in checks/image.check.ts:118

inherit

inherit(priors: IResult): this
Parameters
- priors: IResult
Returns this
Inherited from FileCheck.inherit
- Defined in checks/value.check.ts:25

isTrue

isTrue(
func: (data: any) => boolean | Promise<boolean>,
options?: CheckOptions,
): Promise<ImageCheck>
Parameters
- func: (data: any) => boolean | Promise<boolean>
- Optionaloptions: CheckOptions
Returns Promise<ImageCheck>
Inherited from FileCheck.isTrue
- Defined in checks/value.check.ts:55

`Protected`errorMessage

errorMessage(err: string, options?: CheckOptions): void
Parameters
- err: string
- Optionaloptions: CheckOptions
Returns void
Inherited from FileCheck.errorMessage
- Defined in checks/value.check.ts:66

`Protected`normalizeEqualityValues

normalizeEqualityValues(
    actual: unknown,
    expected: unknown,
    options?: EqualityCheckOptions,
): { actual: unknown; expected: unknown }
Parameters
- actual: unknown
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns { actual: unknown; expected: unknown }
Inherited from FileCheck.normalizeEqualityValues
- Defined in checks/value.check.ts:70

`Protected`equalityMatches

equalityMatches(
    actual: unknown,
    expected: unknown,
    options?: EqualityCheckOptions,
): boolean
Parameters
- actual: unknown
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns boolean
Inherited from FileCheck.equalityMatches
- Defined in checks/value.check.ts:89

`Protected`rules

rules(field_checks: (Check | Promise<Check>)[]): Promise<ImageCheck>
Parameters
- field_checks: (Check | Promise<Check>)[]
Returns Promise<ImageCheck>
Inherited from FileCheck.rules
- Defined in checks/value.check.ts:97

`Protected`composeAlternatives

composeAlternatives(
mode: "anyOf" | "oneOf",
branches: ((checker: this) => (Check | Promise<Check>)[])[],
): Promise<ImageCheck>
Parameters
- mode: "anyOf" | "oneOf"
- branches: ((checker: this) => (Check | Promise<Check>)[])[]
Returns Promise<ImageCheck>
Inherited from FileCheck.composeAlternatives
- Defined in checks/value.check.ts:117

not

not(
func: (checker: this) => (Check | Promise<Check>)[],
options?: CheckOptions,
): Promise<ImageCheck>
Parameters
- func: (checker: this) => (Check | Promise<Check>)[]
- Optionaloptions: CheckOptions
Returns Promise<ImageCheck>
Inherited from FileCheck.not
- Defined in checks/value.check.ts:169

`Protected`createAlternativeChecker

createAlternativeChecker(): this
Returns this
Inherited from FileCheck.createAlternativeChecker
- Defined in checks/value.check.ts:183

`Protected`cloneAlternativeValue

cloneAlternativeValue<T>(value: T): T
Type Parameters
- T
Parameters
- value: T
Returns T
Inherited from FileCheck.cloneAlternativeValue
- Defined in checks/value.check.ts:188

`Protected`mergeBranchResult

mergeBranchResult(result: IResult): void
Parameters
- result: IResult
Returns void
Inherited from FileCheck.mergeBranchResult
- Defined in checks/value.check.ts:208

`Protected`mergeMessageValue

mergeMessageValue(
current?: string | string[],
incoming?: string | string[],
): string | string[] | undefined
Parameters
- Optionalcurrent: string | string[]
- Optionalincoming: string | string[]
Returns string | string[] | undefined
Inherited from FileCheck.mergeMessageValue
- Defined in checks/value.check.ts:236

`Protected`toArray

toArray(value?: string | string[]): string[]
Parameters
- Optionalvalue: string | string[]
Returns string[]
Inherited from FileCheck.toArray
- Defined in checks/value.check.ts:250

result

result(options?: ResultOptions): IResult
Builds the validation result for the current check.
Parameters
- Optionaloptions: ResultOptions
Returns IResult
Inherited from FileCheck.result
- Defined in checks/value.check.ts:258