@progress/kendo-angular-treelist 4.0.6-dev.202203090952 → 5.0.0-next.202204130954

package/dist/es2015/filtering/menu/filter-menu-container.component.js

@@ -1,200 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as tslib_1 from "tslib";
-import { Component, Input, SkipSelf, Output, EventEmitter, ChangeDetectorRef } from '@angular/core';
-import { ColumnComponent } from "../../columns/column.component";
-import { FilterService } from "../filter.service";
-import { removeFilter, filtersByField } from "../base-filter-cell.component";
-import { isPresent, isNullOrEmptyString } from "../../utils";
-import { LocalizationService } from '@progress/kendo-angular-l10n';
-import { cloneFilters } from '../../common/filter-descriptor-differ';
-const isNoValueOperator = operator => (operator === "isnull"
-    || operator === "isnotnull"
-    || operator === "isempty"
-    || operator === "isnotempty");
-const ɵ0 = isNoValueOperator;
-const validFilters = ({ value, operator }) => !isNullOrEmptyString(value) || isNoValueOperator(operator);
-const ɵ1 = validFilters;
-const trimFilters = filter => {
-    filter.filters = filter.filters.filter(validFilters);
-    return filter;
-};
-const ɵ2 = trimFilters;
-const findParent = (filters, field, parent) => {
-    return filters.reduce((acc, filter) => {
-        if (acc) {
-            return acc;
-        }
-        if (filter.filters) {
-            return findParent(filter.filters, field, filter);
-        }
-        else if (filter.field === field) {
-            return parent;
-        }
-        return acc;
-    }, undefined); // tslint:disable-line:align
-};
-const ɵ3 = findParent;
-const parentLogicOfDefault = (filter, field, def = "and") => {
-    const parent = findParent(((filter || {}).filters || []), field);
-    return isPresent(parent) ? parent.logic : def;
-};
-const ɵ4 = parentLogicOfDefault;
-/**
- * @hidden
- */
-let FilterMenuContainerComponent = class FilterMenuContainerComponent {
-    constructor(parentService, childService, localization, cd) {
-        this.parentService = parentService;
-        this.childService = childService;
-        this.localization = localization;
-        this.cd = cd;
-        this.close = new EventEmitter();
-        /**
-         * @hidden
-         */
-        this.actionsClass = 'k-action-buttons k-button-group';
-        this._templateContext = {};
-    }
-    get filter() {
-        return this._filter;
-    }
-    /**
-     * The current root filter.
-     * @type {CompositeFilterDescriptor}
-     */
-    set filter(value) {
-        this._filter = cloneFilters(value);
-    }
-    get childFilter() {
-        if (!isPresent(this._childFilter)) {
-            this._childFilter = {
-                filters: filtersByField(this.filter, (this.column || {}).field),
-                logic: parentLogicOfDefault(this.filter, (this.column || {}).field)
-            };
-        }
-        return this._childFilter;
-    }
-    ngOnInit() {
-        this.subscription = this.childService.changes.subscribe(filter => this._childFilter = filter);
-        this.subscription.add(this.localization.changes.subscribe(() => this.cd.markForCheck()));
-    }
-    ngOnDestroy() {
-        if (this.subscription) {
-            this.subscription.unsubscribe();
-        }
-    }
-    get disabled() {
-        return !this.childFilter.filters.some(validFilters);
-    }
-    get templateContext() {
-        this._templateContext.column = this.column;
-        this._templateContext.filter = this.childFilter;
-        this._templateContext.filterService = this.childService;
-        // tslint:disable-next-line:no-string-literal
-        this._templateContext["$implicit"] = this.childFilter;
-        return this._templateContext;
-    }
-    get hasTemplate() {
-        return isPresent(this.column) && isPresent(this.column.filterMenuTemplateRef);
-    }
-    submit() {
-        const filter = trimFilters(this.childFilter);
-        if (filter.filters.length) {
-            const root = this.filter || {
-                filters: [],
-                logic: "and"
-            };
-            removeFilter(root, this.column.field);
-            root.filters.push(filter);
-            this.parentService.filter(root);
-        }
-        this.close.emit();
-        return false;
-    }
-    reset() {
-        const root = this.filter || {
-            filters: [],
-            logic: "and"
-        };
-        removeFilter(root, this.column.field);
-        this.parentService.filter(root);
-        this.close.emit();
-    }
-    get clearText() {
-        return this.localization.get("filterClearButton");
-    }
-    get filterText() {
-        return this.localization.get("filterFilterButton");
-    }
-};
-tslib_1.__decorate([
-    Output(),
-    tslib_1.__metadata("design:type", EventEmitter)
-], FilterMenuContainerComponent.prototype, "close", void 0);
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", ColumnComponent)
-], FilterMenuContainerComponent.prototype, "column", void 0);
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", Object),
-    tslib_1.__metadata("design:paramtypes", [Object])
-], FilterMenuContainerComponent.prototype, "filter", null);
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", String)
-], FilterMenuContainerComponent.prototype, "actionsClass", void 0);
-FilterMenuContainerComponent = tslib_1.__decorate([
-    Component({
-        providers: [FilterService],
-        selector: 'kendo-treelist-filter-menu-container',
-        template: `
-        <form (submit)="submit()" (reset)="reset()"
-            class="k-filter-menu k-group k-reset k-state-border-up">
-            <div class="k-filter-menu-container">
-                <ng-container [ngSwitch]="hasTemplate">
-                    <ng-container *ngSwitchCase="false">
-                        <ng-container
-                            kendoFilterMenuHost
-                            [filterService]="childService"
-                            [column]="column"
-                            [filter]="childFilter">
-                        </ng-container>
-                    </ng-container>
-                    <ng-container *ngSwitchCase="true">
-                        <ng-template
-                            *ngIf="column.filterMenuTemplateRef"
-                            [ngTemplateOutlet]="column.filterMenuTemplateRef"
-                            [ngTemplateOutletContext]="templateContext"
-                            >
-                        </ng-template>
-                    </ng-container>
-                </ng-container>
-                <div [ngClass]="actionsClass">
-                    <button
-                        type="reset"
-                        class="k-button k-button-solid-base k-button-solid k-button-md k-rounded-md k-button-rectangle">
-                        {{clearText}}
-                    </button>
-                    <button
-                        type="submit"
-                        class="k-button k-button-solid-primary k-button-solid k-button-md k-rounded-md k-button-rectangle"
-                        [disabled]="disabled">
-                        {{filterText}}
-                    </button>
-                </div>
-            </div>
-        </form>
-    `
-    }),
-    tslib_1.__param(0, SkipSelf()),
-    tslib_1.__metadata("design:paramtypes", [FilterService,
-        FilterService,
-        LocalizationService,
-        ChangeDetectorRef])
-], FilterMenuContainerComponent);
-export { FilterMenuContainerComponent };
-export { ɵ0, ɵ1, ɵ2, ɵ3, ɵ4 };

package/dist/es2015/filtering/menu/filter-menu-host.directive.d.ts

@@ -1,17 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import { Type, ViewContainerRef, ComponentFactoryResolver } from "@angular/core";
-import { FilterHostDirective, Context } from "../filter-host.directive";
-import { FilterComponent } from "../filter-component.interface";
-import { FilterService } from "../filter.service";
-/**
- * @hidden
- */
-export declare class FilterMenuHostDirective extends FilterHostDirective {
-    filterService: FilterService;
-    constructor(host: ViewContainerRef, resolver: ComponentFactoryResolver);
-    protected componentType(): Type<FilterComponent>;
-    protected initComponent(ctx: Context): void;
-}

package/dist/es2015/filtering/menu/filter-menu-host.directive.js

@@ -1,41 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as tslib_1 from "tslib";
-import { Directive, ViewContainerRef, ComponentFactoryResolver, Input } from "@angular/core";
-import { FilterHostDirective } from "../filter-host.directive";
-import { isNullOrEmptyString, isPresent } from "../../utils";
-import { filterMenuComponentFactory } from "./filter-menu-component.factory";
-import { StringFilterMenuComponent } from "./string-filter-menu.component";
-import { FilterService } from "../filter.service";
-/**
- * @hidden
- */
-let FilterMenuHostDirective = class FilterMenuHostDirective extends FilterHostDirective {
-    constructor(host, resolver) {
-        super(host, resolver);
-    }
-    componentType() {
-        if (isPresent(this.column) && !isNullOrEmptyString(this.column.filter)) {
-            return filterMenuComponentFactory(this.column.filter);
-        }
-        return StringFilterMenuComponent;
-    }
-    initComponent(ctx) {
-        super.initComponent(ctx);
-        this.component.instance.filterService = this.filterService;
-    }
-};
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", FilterService)
-], FilterMenuHostDirective.prototype, "filterService", void 0);
-FilterMenuHostDirective = tslib_1.__decorate([
-    Directive({
-        selector: '[kendoFilterMenuHost]'
-    }),
-    tslib_1.__metadata("design:paramtypes", [ViewContainerRef,
-        ComponentFactoryResolver])
-], FilterMenuHostDirective);
-export { FilterMenuHostDirective };

package/dist/es2015/filtering/menu/filter-menu-input-wrapper.component.d.ts

@@ -1,34 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import { FilterService } from '../filter.service';
-import { FilterInputWrapperComponent } from "../filter-input-wrapper.component";
-import { CompositeFilterDescriptor, FilterDescriptor } from "@progress/kendo-data-query";
-/**
- * @hidden
- */
-export declare class FilterMenuInputWrapperComponent extends FilterInputWrapperComponent {
-    filterService: FilterService;
-    private _currentFilter;
-    /**
-     * @hidden
-     */
-    readonly hostClasses: boolean;
-    constructor();
-    operatorChange(dataItem: any): void;
-    protected filterChange(filter: CompositeFilterDescriptor): void;
-    /**
-     * The current filter for the associated column field.
-     * @readonly
-     * @type {FilterDescriptor}
-     */
-    /**
-    * The current filter for the associated column field.
-    * @readonly
-    * @type {FilterDescriptor}
-    */
-    currentFilter: FilterDescriptor;
-    protected updateFilter(filter: FilterDescriptor): CompositeFilterDescriptor;
-    onChange(value: any): void;
-}

package/dist/es2015/filtering/menu/filter-menu-input-wrapper.component.js

@@ -1,82 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as tslib_1 from "tslib";
-import { Component, Input } from '@angular/core';
-import { FilterService } from '../filter.service';
-import { FilterInputWrapperComponent } from "../filter-input-wrapper.component";
-/**
- * @hidden
- */
-let FilterMenuInputWrapperComponent = class FilterMenuInputWrapperComponent extends FilterInputWrapperComponent {
-    constructor() {
-        super(null);
-    }
-    /**
-     * @hidden
-     */
-    get hostClasses() {
-        return false;
-    }
-    operatorChange(dataItem) {
-        this.currentOperator = dataItem;
-    }
-    filterChange(filter) {
-        this.applyFilter(filter);
-    }
-    /**
-     * The current filter for the associated column field.
-     * @readonly
-     * @type {FilterDescriptor}
-     */
-    get currentFilter() {
-        return this._currentFilter;
-    }
-    /**
-     * The current filter for the associated column field.
-     * @readonly
-     * @type {FilterDescriptor}
-     */
-    set currentFilter(value) {
-        this._currentFilter = value;
-    }
-    updateFilter(filter) {
-        Object.assign(this.currentFilter, filter);
-        return this.filter;
-    }
-    onChange(value) {
-        this.filterChange(this.updateFilter({
-            field: this.column.field,
-            operator: this.currentOperator,
-            value: value
-        }));
-    }
-};
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", FilterService)
-], FilterMenuInputWrapperComponent.prototype, "filterService", void 0);
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", Object),
-    tslib_1.__metadata("design:paramtypes", [Object])
-], FilterMenuInputWrapperComponent.prototype, "currentFilter", null);
-FilterMenuInputWrapperComponent = tslib_1.__decorate([
-    Component({
-        selector: 'kendo-treelist-filter-menu-input-wrapper',
-        template: `
-        <kendo-dropdownlist
-            [data]="operators"
-            (valueChange)="operatorChange($event)"
-            [value]="currentOperator"
-            [valuePrimitive]="true"
-            textField="text"
-            valueField="value">
-        </kendo-dropdownlist>
-        <ng-content></ng-content>
-    `
-    }),
-    tslib_1.__metadata("design:paramtypes", [])
-], FilterMenuInputWrapperComponent);
-export { FilterMenuInputWrapperComponent };

package/dist/es2015/filtering/menu/filter-menu-template.directive.d.ts

@@ -1,13 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import { TemplateRef } from '@angular/core';
-/**
- * Represents the filter-menu template
- * ([see example]({% slug builtinfiltertemplate_treelist %}#toc-customizing-filter-menus)).
- */
-export declare class FilterMenuTemplateDirective {
-    templateRef: TemplateRef<any>;
-    constructor(templateRef: TemplateRef<any>);
-}

package/dist/es2015/filtering/menu/filter-menu-template.directive.js

@@ -1,23 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as tslib_1 from "tslib";
-import { Directive, TemplateRef, Optional } from '@angular/core';
-/**
- * Represents the filter-menu template
- * ([see example]({% slug builtinfiltertemplate_treelist %}#toc-customizing-filter-menus)).
- */
-let FilterMenuTemplateDirective = class FilterMenuTemplateDirective {
-    constructor(templateRef) {
-        this.templateRef = templateRef;
-    }
-};
-FilterMenuTemplateDirective = tslib_1.__decorate([
-    Directive({
-        selector: '[kendoTreeListFilterMenuTemplate]'
-    }),
-    tslib_1.__param(0, Optional()),
-    tslib_1.__metadata("design:paramtypes", [TemplateRef])
-], FilterMenuTemplateDirective);
-export { FilterMenuTemplateDirective };

package/dist/es2015/filtering/menu/filter-menu.component.d.ts

@@ -1,36 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import { FilterService } from "../filter.service";
-import { CompositeFilterDescriptor } from "@progress/kendo-data-query";
-import { ColumnComponent } from '../../columns/column.component';
-import { SinglePopupService } from '../../common/single-popup.service';
-import { LocalizationService } from "@progress/kendo-angular-l10n";
-/**
- * @hidden
- */
-export declare class FilterMenuComponent {
-    protected filterService: FilterService;
-    protected popupService: SinglePopupService;
-    protected localization: LocalizationService;
-    /**
-     * The column with which the filter is associated.
-     * @type {ColumnComponent}
-     */
-    column: ColumnComponent;
-    /**
-     * The current root filter.
-     * @type {CompositeFilterDescriptor}
-     */
-    filter: CompositeFilterDescriptor;
-    /**
-     * @hidden
-     */
-    filterLabel: string;
-    private popupRef;
-    constructor(filterService: FilterService, popupService: SinglePopupService, localization: LocalizationService);
-    readonly hasFilters: boolean;
-    toggle(anchor: any, template: any): boolean;
-    close(): void;
-}

package/dist/es2015/filtering/menu/filter-menu.component.js

@@ -1,69 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as tslib_1 from "tslib";
-import { Component, Input } from '@angular/core';
-import { FilterService } from "../filter.service";
-import { ColumnComponent } from '../../columns/column.component';
-import { SinglePopupService } from '../../common/single-popup.service';
-import { filtersByField } from '../base-filter-cell.component';
-import { LocalizationService } from "@progress/kendo-angular-l10n";
-/**
- * @hidden
- */
-let FilterMenuComponent = class FilterMenuComponent {
-    constructor(filterService, popupService, localization) {
-        this.filterService = filterService;
-        this.popupService = popupService;
-        this.localization = localization;
-        /**
-         * @hidden
-         */
-        this.filterLabel = this.localization.get('filter');
-    }
-    get hasFilters() {
-        return filtersByField(this.filter, (this.column || {}).field).length > 0;
-    }
-    toggle(anchor, template) {
-        this.popupRef = this.popupService.open(anchor, template, this.popupRef);
-        return false;
-    }
-    close() {
-        this.popupService.destroy();
-    }
-};
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", ColumnComponent)
-], FilterMenuComponent.prototype, "column", void 0);
-tslib_1.__decorate([
-    Input(),
-    tslib_1.__metadata("design:type", Object)
-], FilterMenuComponent.prototype, "filter", void 0);
-FilterMenuComponent = tslib_1.__decorate([
-    Component({
-        selector: 'kendo-treelist-filter-menu',
-        template: `
-        <a #anchor
-            [ngClass]="{'k-grid-filter':true, 'k-state-active': hasFilters}"
-            (click)="toggle(anchor, template)"
-            href="#"
-            [attr.title]="filterLabel">
-            <span class="k-icon k-i-filter"></span>
-        </a>
-        <ng-template #template>
-            <kendo-treelist-filter-menu-container
-                [column]="column"
-                [filter]="filter"
-                (close)="close()"
-                >
-            </kendo-treelist-filter-menu-container>
-        </ng-template>
-    `
-    }),
-    tslib_1.__metadata("design:paramtypes", [FilterService,
-        SinglePopupService,
-        LocalizationService])
-], FilterMenuComponent);
-export { FilterMenuComponent };

package/dist/es2015/filtering/menu/filter-menu.module.d.ts

@@ -1,10 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-/**
- * @hidden
- */
-export declare class FilterMenuModule {
-    static exports(): any[];
-}

package/dist/es2015/filtering/menu/filter-menu.module.js

@@ -1,63 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as tslib_1 from "tslib";
-import { NgModule } from '@angular/core';
-import { FilterMenuComponent } from "./filter-menu.component";
-import { FilterMenuContainerComponent } from "./filter-menu-container.component";
-import { FilterMenuInputWrapperComponent } from "./filter-menu-input-wrapper.component";
-import { StringFilterMenuInputComponent } from "./string-filter-menu-input.component";
-import { StringFilterMenuComponent } from './string-filter-menu.component';
-import { SharedFilterModule } from '../shared-filtering.module';
-import { FilterMenuTemplateDirective } from './filter-menu-template.directive';
-import { NumericFilterMenuComponent } from './numeric-filter-menu.component';
-import { NumericFilterMenuInputComponent } from './numeric-filter-menu-input.component';
-import { FilterMenuHostDirective } from './filter-menu-host.directive';
-import { DateFilterMenuInputComponent } from './date-filter-menu-input.component';
-import { DateFilterMenuComponent } from './date-filter-menu.component';
-import { BooleanFilterMenuComponent } from './boolean-filter-menu.component';
-const INTERNAL_COMPONENTS = [
-    FilterMenuComponent,
-    FilterMenuContainerComponent,
-    FilterMenuInputWrapperComponent,
-    StringFilterMenuInputComponent,
-    StringFilterMenuComponent,
-    FilterMenuTemplateDirective,
-    NumericFilterMenuComponent,
-    NumericFilterMenuInputComponent,
-    DateFilterMenuInputComponent,
-    DateFilterMenuComponent,
-    FilterMenuHostDirective,
-    BooleanFilterMenuComponent
-];
-const ENTRY_COMPONENTS = [
-    StringFilterMenuComponent,
-    NumericFilterMenuComponent,
-    DateFilterMenuComponent,
-    BooleanFilterMenuComponent
-];
-/**
- * @hidden
- */
-let FilterMenuModule = class FilterMenuModule {
-    static exports() {
-        return [
-            StringFilterMenuComponent,
-            FilterMenuTemplateDirective,
-            NumericFilterMenuComponent,
-            DateFilterMenuComponent,
-            BooleanFilterMenuComponent,
-            SharedFilterModule.exports()
-        ];
-    }
-};
-FilterMenuModule = tslib_1.__decorate([
-    NgModule({
-        declarations: [INTERNAL_COMPONENTS],
-        entryComponents: ENTRY_COMPONENTS,
-        exports: [INTERNAL_COMPONENTS, SharedFilterModule],
-        imports: [SharedFilterModule]
-    })
-], FilterMenuModule);
-export { FilterMenuModule };

package/dist/es2015/filtering/menu/numeric-filter-menu-input.component.d.ts

@@ -1,53 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2021 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the project root for more information
-*-------------------------------------------------------------------------------------------*/
-import { FilterDescriptor, CompositeFilterDescriptor } from '@progress/kendo-data-query';
-import { ColumnComponent } from "../../columns/column.component";
-import { FilterService } from '../filter.service';
-/**
- * @hidden
- */
-export declare class NumericFilterMenuInputComponent {
-    operators: Array<{
-        text: string;
-        value: string;
-    }>;
-    column: ColumnComponent;
-    filter: CompositeFilterDescriptor;
-    operator: string;
-    currentFilter: FilterDescriptor;
-    filterService: FilterService;
-    /**
-     * Specifies the value which is used to increment or decrement the component value.
-     * @type {numeric}
-     */
-    step: number;
-    /**
-     * Specifies the smallest value that is valid.
-     * @type {number}
-     */
-    min: number;
-    /**
-     * Specifies the greatest value that is valid.
-     * @type {number}
-     */
-    max: number;
-    /**
-     * Specifies whether the **Up** and **Down** spin buttons will be rendered.
-     * @type {boolean}
-     */
-    spinners: boolean;
-    /**
-     * Specifies the number precision tat is applied to the component value when it is focused.
-     * If the user enters a number with a greater precision than is currently configured, the component value is rounded.
-     *
-     * @type {number}
-     */
-    decimals: number;
-    /**
-     * Specifies the number format that is used when the component is not focused.
-     * By default, the `column.format` value is used (if set).
-     */
-    format: string;
-}