Skip to content

Commit

Permalink
docs: update dicomModel jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Chinlinlee committed Aug 11, 2023
1 parent 066d21e commit 221a740
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions models/mongodb/models/dicom.js
Original file line number Diff line number Diff line change
Expand Up @@ -449,26 +449,19 @@ dicomModelSchema.statics.getInstanceOfMedianIndex = async function (query) {
};

/**
* @typedef {function(s: string, b: boolean): Promise<number>} getDicomJson
* @param {object} iParam
* @param {string} iParam.studyUID
* @param {string} iParam.seriesUID
* @param {string} iParam.instanceUID
* @returns
*/

/**
* @typedef { mongoose.Model<dicomModelSchema> & {
* getPathOfInstance: function(iParam: {
* studyUID: string,
* seriesUID: string,
* instanceUID: string
* }): Promise<import("../../../utils/typeDef/WADO-RS/WADO-RS.def").ImagePathObj>;
* getDicomJson: function(queryOptions: import("../../../utils/typeDef/dicom").DicomJsonMongoQueryOptions): Promise<function>;
* getInstanceOfMedianIndex: function(studyUID: string, seriesUID: string): Promise<any>
* @typedef {import("mongoose").Model<dicomModelSchema> & {
* getPathOfInstance: (iParam: {
* studyUID: string,
* seriesUID: string,
* instanceUID: string
* }) => Promise<import("../../../utils/typeDef/WADO-RS/WADO-RS.def").ImagePathObj>;
* getDicomJson: (queryOptions: import("../../../utils/typeDef/dicom").DicomJsonMongoQueryOptions) => Promise<any>;
* getInstanceOfMedianIndex: (studyUID: string, seriesUID: string) => Promise<any>;
* }} DicomModelSchema
*
*/


/** @type {DicomModelSchema} */
let dicomModel = mongoose.model("dicom", dicomModelSchema, "dicom");

Expand Down

0 comments on commit 221a740

Please sign in to comment.