@indexea/sdk/models/QuerySortField.ts

Indexea JavaScript SDK (indexea.com)

/* tslint:disable */
/* eslint-disable */
/**
 * Indexea OpenAPI
 * 这是 Indexea 搜索服务平台的 OpenAPI，用于描述平台的所有接口信息，你可以通过这个页面来了解和在线验证平台的所有接口信息。  ### Errors  本 API 使用标准的 HTTP 状态码来指示操作成功或者失败，如果失败将会在 body 中以 JSON 格式提供详细的错误信息，如下所示：  ``` {   \"error\": 404,   \"message\": \"page not found\" } ``` 
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: indexea.com@gmail.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { exists, mapValues } from '../runtime';
/**
 * 可用于通过参数进行自定义排序的字段
 * @export
 * @interface QuerySortField
 */
export interface QuerySortField {
    /**
     * 排序字段名
     * @type {string}
     * @memberof QuerySortField
     */
    field?: string;
    /**
     * 排序字段在前端显示的名称
     * @type {string}
     * @memberof QuerySortField
     */
    label?: string;
    /**
     * 默认排序方式
     * @type {string}
     * @memberof QuerySortField
     */
    order?: QuerySortFieldOrderEnum;
}


/**
 * @export
 */
export const QuerySortFieldOrderEnum = {
    Asc: 'asc',
    Desc: 'desc'
} as const;
export type QuerySortFieldOrderEnum = typeof QuerySortFieldOrderEnum[keyof typeof QuerySortFieldOrderEnum];


/**
 * Check if a given object implements the QuerySortField interface.
 */
export function instanceOfQuerySortField(value: object): boolean {
    let isInstance = true;

    return isInstance;
}

export function QuerySortFieldFromJSON(json: any): QuerySortField {
    return QuerySortFieldFromJSONTyped(json, false);
}

export function QuerySortFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuerySortField {
    if ((json === undefined) || (json === null)) {
        return json;
    }
    return {
        
        'field': !exists(json, 'field') ? undefined : json['field'],
        'label': !exists(json, 'label') ? undefined : json['label'],
        'order': !exists(json, 'order') ? undefined : json['order'],
    };
}

export function QuerySortFieldToJSON(value?: QuerySortField | null): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'field': value.field,
        'label': value.label,
        'order': value.order,
    };
}