Class Listing

Hierarchy

Listing

Implements

ListingService

Index

Constructors

constructor

new Listing(api): Listing
Parameters
- api: Api
Returns Listing
- Defined in src/lib/services/edocu/listing.ts:39

Properties

api

api: Api

Methods

get

get(type, criteria, projection, sort?, page?, limit?, atTime?, queryParams?): Promise<ApiResponse<ElementDataWrapper[]>>
Parameters
- type: null | string | string[]
- criteria: FormattedCriteria
- projection: string[]
- Optional sort: Record<string, 1 | -1>
- page: number = 1
- limit: number = 100
- Optional atTime: string
- Optional queryParams: Record<string, unknown>
Returns Promise<ApiResponse<ElementDataWrapper[]>>
Implementation of ListingService.get
- Defined in src/lib/services/edocu/listing.ts:434

getListingRequestHash

getListingRequestHash(params, organization, context): string
Parameters
- params: [type: null | string | string[], criteria: FormattedCriteria, projection: string[], sort?: Record<string, 1 | -1>, page?: number, limit?: number, atTime?: string, queryParams?: Record<string, unknown>]
- organization: string
- context: DynamicContext
Returns string
- Defined in src/lib/services/edocu/listing.ts:111

loadAllElements

loadAllElements(totalCount, criteria, type, projection, options, onLoadCurrentPage?, queryParams?): Promise<ElementDataWrapper[]>
Parameters
- totalCount: number
- criteria: FormattedCriteria
- type: null | string | string[]
- projection: string[]
- options: IQueryOptions
- Optional onLoadCurrentPage: ((rows, pagesToLeft?) => Promise<void>)
  - - (rows, pagesToLeft?): Promise<void>
    - Parameters
      
      rows: ElementDataWrapper[]
      
      Optional pagesToLeft: number
      
      Returns Promise<void>
- Optional queryParams: Record<string, unknown>
Returns Promise<ElementDataWrapper[]>
- Defined in src/lib/services/edocu/listing.ts:490

parseCriteria

parseCriteria(criteria, context?, initial?): FormattedCriteria
Parameters
- criteria: QueryCriteria
- Optional context: DynamicContext
- initial: FormattedCriteria = {}
Returns FormattedCriteria
- Defined in src/lib/services/edocu/listing.ts:43

parseDynamicFilter

parseDynamicFilter(rawValue, context?): FormattedCriterium
Parameters
- rawValue: unknown
- Optional context: DynamicContext
Returns FormattedCriterium
- Defined in src/lib/services/edocu/listing.ts:566

`Static` `Private` deconstructCriterion

deconstructCriterion(criterion): {
    key: string;
    logicOperation?: ">" | "<" | "EQUAL" | "NOTEQUAL" | "IN" | "NOTIN" | "≥" | "≤" | "CONTAINSWORD";
    type?: string;
    value: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
    } | {
        $near: Record<string, unknown>;
    } | IOnElementQuery;
}
Parameters
- criterion: string | IListingFilter
Returns {
    key: string;
    logicOperation?: ">" | "<" | "EQUAL" | "NOTEQUAL" | "IN" | "NOTIN" | "≥" | "≤" | "CONTAINSWORD";
    type?: string;
    value: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
    } | {
        $near: Record<string, unknown>;
    } | IOnElementQuery;
}
- key: string
- Optional logicOperation?: ">" | "<" | "EQUAL" | "NOTEQUAL" | "IN" | "NOTIN" | "≥" | "≤" | "CONTAINSWORD"
- Optional type?: string
- value: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
  $ne: string;
  } | {
  $near: Record<string, unknown>;
  } | IOnElementQuery
- Defined in src/lib/services/edocu/listing.ts:204

`Static` formatCriteria

formatCriteria(criteria): QueryCriteria
Parameters
- criteria: IListingFilter[]
Returns QueryCriteria
- Defined in src/lib/services/edocu/listing.ts:180

`Static` `Private` formatCriterionReducer

formatCriterionReducer(criterion): undefined | {}
Parameters
- criterion: string | IListingFilter
Returns undefined | {}
- Defined in src/lib/services/edocu/listing.ts:233

`Static` `Private` getComparatorConfig

getComparatorConfig(criterion): {
    <: {
        attrTypes: string[];
        getCriterion: (() => {
            $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    >: {
        attrTypes: string[];
        getCriterion: (() => {
            $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    CONTAINSWORD: {
        attrTypes: string[];
        getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery);
    };
    EQUAL: {
        attrTypes: string[];
        getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery);
    };
    EXISTS: {
        attrTypes: string[];
        getCriterion: (() => {
            $exists: boolean;
        });
    };
    IN: {
        attrTypes: string[];
        getCriterion: (() => {
            $in: string[];
        });
    };
    NOTEQUAL: {
        attrTypes: string[];
        getCriterion: (() => {
            $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    NOTEXIST: {
        attrTypes: string[];
        getCriterion: (() => {
            $exists: boolean;
        });
    };
    NOTIN: {
        attrTypes: string[];
        getCriterion: (() => {
            $not: {
                $in: string[];
            };
        });
    };
    ≤: {
        attrTypes: string[];
        getCriterion: (() => {
            $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    ≥: {
        attrTypes: string[];
        getCriterion: (() => {
            $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
}
Parameters
- criterion: IListingFilter
Returns {
    <: {
        attrTypes: string[];
        getCriterion: (() => {
            $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    >: {
        attrTypes: string[];
        getCriterion: (() => {
            $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    CONTAINSWORD: {
        attrTypes: string[];
        getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery);
    };
    EQUAL: {
        attrTypes: string[];
        getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery);
    };
    EXISTS: {
        attrTypes: string[];
        getCriterion: (() => {
            $exists: boolean;
        });
    };
    IN: {
        attrTypes: string[];
        getCriterion: (() => {
            $in: string[];
        });
    };
    NOTEQUAL: {
        attrTypes: string[];
        getCriterion: (() => {
            $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    NOTEXIST: {
        attrTypes: string[];
        getCriterion: (() => {
            $exists: boolean;
        });
    };
    NOTIN: {
        attrTypes: string[];
        getCriterion: (() => {
            $not: {
                $in: string[];
            };
        });
    };
    ≤: {
        attrTypes: string[];
        getCriterion: (() => {
            $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
    ≥: {
        attrTypes: string[];
        getCriterion: (() => {
            $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        });
    };
}
- <: {
      attrTypes: string[];
      getCriterion: (() => {
          $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
              $ne: string;
          } | {
              $near: Record<string, unknown>;
          } | IOnElementQuery;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
        $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    })
    - - (): {
            $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
      - Returns {
            $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
        
        $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery
- >: {
      attrTypes: string[];
      getCriterion: (() => {
          $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
              $ne: string;
          } | {
              $near: Record<string, unknown>;
          } | IOnElementQuery;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
        $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    })
    - - (): {
            $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
      - Returns {
            $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
        
        $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery
- CONTAINSWORD: {
      attrTypes: string[];
      getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
          $ne: string;
      } | {
          $near: Record<string, unknown>;
      } | IOnElementQuery);
  }
  - attrTypes: string[]
  - getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
    $ne: string;
    } | {
    $near: Record<string, unknown>;
    } | IOnElementQuery)
    - - (): null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
        } | {
        $near: Record<string, unknown>;
        } | IOnElementQuery
      - Returns null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
        } | {
        $near: Record<string, unknown>;
        } | IOnElementQuery
- EQUAL: {
      attrTypes: string[];
      getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
          $ne: string;
      } | {
          $near: Record<string, unknown>;
      } | IOnElementQuery);
  }
  - attrTypes: string[]
  - getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
    $ne: string;
    } | {
    $near: Record<string, unknown>;
    } | IOnElementQuery)
    - - (): null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
        } | {
        $near: Record<string, unknown>;
        } | IOnElementQuery
      - Returns null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
        } | {
        $near: Record<string, unknown>;
        } | IOnElementQuery
- EXISTS: {
      attrTypes: string[];
      getCriterion: (() => {
          $exists: boolean;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
    $exists: boolean;
    })
    - - (): {
        $exists: boolean;
        }
      - Returns {
        $exists: boolean;
        }
        
        $exists: boolean
- IN: {
      attrTypes: string[];
      getCriterion: (() => {
          $in: string[];
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
    $in: string[];
    })
    - - (): {
        $in: string[];
        }
      - Returns {
        $in: string[];
        }
        
        $in: string[]
- NOTEQUAL: {
      attrTypes: string[];
      getCriterion: (() => {
          $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
              $ne: string;
          } | {
              $near: Record<string, unknown>;
          } | IOnElementQuery;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
        $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    })
    - - (): {
            $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
      - Returns {
            $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
        
        $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery
- NOTEXIST: {
      attrTypes: string[];
      getCriterion: (() => {
          $exists: boolean;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
    $exists: boolean;
    })
    - - (): {
        $exists: boolean;
        }
      - Returns {
        $exists: boolean;
        }
        
        $exists: boolean
- NOTIN: {
      attrTypes: string[];
      getCriterion: (() => {
          $not: {
              $in: string[];
          };
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
        $not: {
            $in: string[];
        };
    })
    - - (): {
            $not: {
                $in: string[];
            };
        }
      - Returns {
            $not: {
                $in: string[];
            };
        }
        
        $not: {
            $in: string[];
        }
        
        $in: string[]
- ≤: {
      attrTypes: string[];
      getCriterion: (() => {
          $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
              $ne: string;
          } | {
              $near: Record<string, unknown>;
          } | IOnElementQuery;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
        $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    })
    - - (): {
            $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
      - Returns {
            $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
        
        $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery
- ≥: {
      attrTypes: string[];
      getCriterion: (() => {
          $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
              $ne: string;
          } | {
              $near: Record<string, unknown>;
          } | IOnElementQuery;
      });
  }
  - attrTypes: string[]
  - getCriterion: (() => {
        $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    })
    - - (): {
            $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
      - Returns {
            $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
                $ne: string;
            } | {
                $near: Record<string, unknown>;
            } | IOnElementQuery;
        }
        
        $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery
- Defined in src/lib/services/edocu/listing.ts:287

`Static` getCriterionName

getCriterionName(key): string
Parameters
- key: string
Returns string
- Defined in src/lib/services/edocu/listing.ts:254

`Static` `Private` getCriterionValue

getCriterionValue(criterion): {
    attrTypes: string[];
    getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
    } | {
        $near: Record<string, unknown>;
    } | IOnElementQuery);
} | {
    attrTypes: string[];
    getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
    } | {
        $near: Record<string, unknown>;
    } | IOnElementQuery);
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $in: string[];
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $not: {
            $in: string[];
        };
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
}
Parameters
- criterion: IListingFilter
Returns {
    attrTypes: string[];
    getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
    } | {
        $near: Record<string, unknown>;
    } | IOnElementQuery);
} | {
    attrTypes: string[];
    getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
        $ne: string;
    } | {
        $near: Record<string, unknown>;
    } | IOnElementQuery);
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $in: string[];
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $not: {
            $in: string[];
        };
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
} | {
    attrTypes: string[];
    getCriterion: (() => {
        $lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
            $ne: string;
        } | {
            $near: Record<string, unknown>;
        } | IOnElementQuery;
    });
}
- Defined in src/lib/services/edocu/listing.ts:266

`Static` `Private` getDateRangeCriterion

getDateRangeCriterion(criterionValue): DateQuery
Parameters
- criterionValue: string | [string, string]
Returns DateQuery
- Defined in src/lib/services/edocu/listing.ts:419

`Static` getDefaultLogicOperation

getDefaultLogicOperation(attributeType): "EQUAL" | "CONTAINSWORD"
Parameters
- attributeType: undefined | string
Returns "EQUAL" | "CONTAINSWORD"
- Defined in src/lib/services/edocu/listing.ts:258

`Static` `Private` isValidDate

isValidDate(val, type): val is [string, string]
Parameters
- val: unknown
- type: string
Returns val is [string, string]
- Defined in src/lib/services/edocu/listing.ts:273

`Static` parsePresetConfig

parsePresetConfig(preset): IListingConfig
Parameters
- preset: IListingPreset
Returns IListingConfig
- Defined in src/lib/services/edocu/listing.ts:135

Class Listing

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

api: Api

Returns Listing

Properties

api

Methods

get

Parameters

type: null | string | string[]

criteria: FormattedCriteria

projection: string[]

Optional sort: Record<string, 1 | -1>

page: number = 1

limit: number = 100

Optional atTime: string

Optional queryParams: Record<string, unknown>

Returns Promise<ApiResponse<ElementDataWrapper[]>>

getListingRequestHash

Parameters

params: [type: null | string | string[], criteria: FormattedCriteria, projection: string[], sort?: Record<string, 1 | -1>, page?: number, limit?: number, atTime?: string, queryParams?: Record<string, unknown>]

organization: string

context: DynamicContext

Returns string

loadAllElements

Parameters

totalCount: number

criteria: FormattedCriteria

type: null | string | string[]

projection: string[]

options: IQueryOptions

Optional onLoadCurrentPage: ((rows, pagesToLeft?) => Promise<void>)

Parameters

rows: ElementDataWrapper[]

Optional pagesToLeft: number

Returns Promise<void>

Optional queryParams: Record<string, unknown>

Returns Promise<ElementDataWrapper[]>

parseCriteria

Parameters

criteria: QueryCriteria

Optional context: DynamicContext

initial: FormattedCriteria = {}

Returns FormattedCriteria

parseDynamicFilter

Parameters

rawValue: unknown

Optional context: DynamicContext

Returns FormattedCriterium

Static Private deconstructCriterion

Parameters

criterion: string | IListingFilter

key: string

Optional logicOperation?: ">" | "<" | "EQUAL" | "NOTEQUAL" | "IN" | "NOTIN" | "≥" | "≤" | "CONTAINSWORD"

Optional type?: string

value: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | { $ne: string; } | { $near: Record<string, unknown>; } | IOnElementQuery

Static formatCriteria

Parameters

criteria: IListingFilter[]

Returns QueryCriteria

Static Private formatCriterionReducer

Parameters

criterion: string | IListingFilter

Returns undefined | {}

Static Private getComparatorConfig

Parameters

criterion: IListingFilter

<: { attrTypes: string[]; getCriterion: (() => { $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | { $ne: string; } | { $near: Record<string, unknown>; } | IOnElementQuery; }); }

attrTypes: string[]

getCriterion: (() => { $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | { $ne: string; } | { $near: Record<string, unknown>; } | IOnElementQuery; })

Returns { $lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | { $ne: string; } | { $near: Record<string, unknown>; } | IOnElementQuery; }

$lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | { $ne: string; } | { $near: Record<string, unknown>; } | IOnElementQuery

`Optional` sort: Record<string, 1 | -1>

`Optional` atTime: string

`Optional` queryParams: Record<string, unknown>

`Optional` onLoadCurrentPage: ((rows, pagesToLeft?) => Promise<void>)

`Optional` pagesToLeft: number

`Optional` queryParams: Record<string, unknown>

`Optional` context: DynamicContext

`Optional` context: DynamicContext

`Static` `Private` deconstructCriterion

`Optional` logicOperation?: ">" | "<" | "EQUAL" | "NOTEQUAL" | "IN" | "NOTIN" | "≥" | "≤" | "CONTAINSWORD"

`Optional` type?: string

value: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

`Static` formatCriteria

`Static` `Private` formatCriterionReducer

`Static` `Private` getComparatorConfig

<: {
attrTypes: string[];
getCriterion: (() => {
$lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
});
}

getCriterion: (() => {
$lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
})

Returns {
$lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
}

$lt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

>: {
attrTypes: string[];
getCriterion: (() => {
$gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
});
}

getCriterion: (() => {
$gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
})

Returns {
$gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
}

$gt: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

CONTAINSWORD: {
attrTypes: string[];
getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery);
}

getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery)

Returns null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

EQUAL: {
attrTypes: string[];
getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery);
}

getCriterion: (() => null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery)

Returns null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

EXISTS: {
attrTypes: string[];
getCriterion: (() => {
$exists: boolean;
});
}

getCriterion: (() => {
$exists: boolean;
})

Returns {
$exists: boolean;
}

IN: {
attrTypes: string[];
getCriterion: (() => {
$in: string[];
});
}

getCriterion: (() => {
$in: string[];
})

Returns {
$in: string[];
}

NOTEQUAL: {
attrTypes: string[];
getCriterion: (() => {
$not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
});
}

getCriterion: (() => {
$not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
})

Returns {
$not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
}

$not: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

NOTEXIST: {
attrTypes: string[];
getCriterion: (() => {
$exists: boolean;
});
}

getCriterion: (() => {
$exists: boolean;
})

Returns {
$exists: boolean;
}

NOTIN: {
attrTypes: string[];
getCriterion: (() => {
$not: {
$in: string[];
};
});
}

getCriterion: (() => {
$not: {
$in: string[];
};
})

Returns {
$not: {
$in: string[];
};
}

$not: {
$in: string[];
}

≤: {
attrTypes: string[];
getCriterion: (() => {
$lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
});
}

getCriterion: (() => {
$lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
})

Returns {
$lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
}

$lte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

≥: {
attrTypes: string[];
getCriterion: (() => {
$gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
});
}

getCriterion: (() => {
$gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
})

Returns {
$gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery;
}

$gte: null | string | number | string[] | DateQuery | IDateGteCriterion | IDateLtCriterion | IDateLteCriterion | ILocationCriterion | {
$ne: string;
} | {
$near: Record<string, unknown>;
} | IOnElementQuery

`Static` getCriterionName

`Static` `Private` getCriterionValue

`Static` `Private` getDateRangeCriterion

`Static` getDefaultLogicOperation

`Static` `Private` isValidDate