Class ZMetadataBuilder

Represents a builder for metadata.

Index

Constructors

Properties

boolean custom date file icon image number text

Methods

build cls copy description editable fallback format height id name path precision sortable square type width

Constructors

constructor

new ZMetadataBuilder(): ZMetadataBuilder
Initializes a new instance of this object.

Returns ZMetadataBuilder
- Defined in packages/helpful-query/src/metadata/metadata.mts:181

Properties

boolean

boolean: (...args: []) => ZMetadataBuilder = ...

Sets the type as a boolean.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

custom

custom: (...args: []) => ZMetadataBuilder = ...

Sets the type as custom.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

date

date: (...args: []) => ZMetadataBuilder = ...

Sets the type as date.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

file

file: (...args: []) => ZMetadataBuilder = ...

Sets the type as file.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

icon

icon: (...args: []) => ZMetadataBuilder = ...

Sets the type as an icon.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

image

image: (...args: []) => ZMetadataBuilder = ...

Sets the type as an image.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

number

number: (...args: []) => ZMetadataBuilder = ...

Sets the type as a number.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

text

text: (...args: []) => ZMetadataBuilder = ...

Sets the type as text.

Type Declaration

- (...args: []): ZMetadataBuilder
- Parameters
  - ...args: []
  Returns ZMetadataBuilder
  This object.

Methods

build

build(): IZMetadata
Returns the constructed metadata.

Returns IZMetadata
The built metadata.
- Defined in packages/helpful-query/src/metadata/metadata.mts:472

cls

cls(val?: string): this
Sets the class type of the metadata.
Parameters
- Optionalval: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:286

copy

copy(other: IZMetadata): this
Copies another metadata object into this object.
Parameters
- other: IZMetadata
  The metadata to copy.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:461

description

description(val: string): this
Sets the description for the field.
Parameters
- val: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:244

editable

editable(value?: boolean): ZMetadataBuilder
Sets the metadata as editable.
Parameters
- value: boolean = true
  The value to set.
Returns ZMetadataBuilder
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:447

fallback

fallback(val: any): this
Sets the fallback value for the field.
Parameters
- val: any
  The fallback value.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:258

format

format(val?: string): this
Sets the format of the metadata.
Parameters
- Optionalval: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:272

height

height(val?: string): this
Sets the height of the metadata.
Parameters
- Optionalval: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:328

id

id(val?: string): this
Sets the id of the metadata.
Parameters
- val: string = ...
  The value to set. If this is undefined, then a new guid will be set as the value.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:202

name

name(val: string): this
Sets the name of the metadata.
Parameters
- val: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:216

path

path(val: string): this
Sets the path of the metadata.
Parameters
- val: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:230

precision

precision(val?: number): this
Sets the precision of the metadata.
Parameters
- Optionalval: number
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:300

sortable

sortable(value?: boolean): ZMetadataBuilder
Sets the metadata as sortable.
Parameters
- value: boolean = true
  The value to set.
Returns ZMetadataBuilder
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:433

square

square(val?: string): this
Sets both width and height.
Parameters
- Optionalval: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:342

type

type(val: ZMetadataType): this
Sets the type of the metadata.
Parameters
- val: ZMetadataType
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:355

width

width(val?: string): this
Sets the width of the metadata.
Parameters
- Optionalval: string
  The value to set.
Returns this
This object.
- Defined in packages/helpful-query/src/metadata/metadata.mts:314