কিভাবে সীমাবদ্ধ সম্ভাব্য মান সহ jsdoc এ স্ট্রিং টাইপ ডকুমেন্ট করবেন

Question 1

আমার একটি ফাংশন হচ্ছে যা একটি স্ট্রিং প্যারামিটার গ্রহণ করে। এই পরামিতিটির কয়েকটি সংজ্ঞায়িত সম্ভাব্য মানগুলির মধ্যে একটি হতে পারে। একই নথির ভাল উপায় কি? শেপটাইপ কি এনাম বা টাইপডিফ বা অন্য কিছু হিসাবে সংজ্ঞায়িত করা উচিত?

Shape.prototype.create = function (shapeType) {
    // shapeType can be "rect", "circle" or "ellipse"...
    this.type = shapeType;
};

Shape.prototype.getType = function (shapeType) {
    // shapeType can be "rect", "circle" or "ellipse"...
    return this.type;
};

সমস্যার দ্বিতীয় অংশটি হ'ল সম্ভাব্য মানগুলি shapeTypeসেই ফাইলে shapeTypeজানা নেই যা আপনার প্রস্তাব অনুযায়ী যা সংজ্ঞায়িত করে। বেশ কয়েকটি বিকাশকারী দ্বারা অবদান করা একাধিক ফাইল রয়েছে যারা এর সম্ভাব্য মানগুলিতে যুক্ত করতে পারে shapeType।

PS: আমি ব্যবহার করছি jsdoc3

Question 2

ডামি এনাম ঘোষণার বিষয়ে:

/**
 * Enum string values.
 * @enum {string}
 */
Enumeration = {
    ONE: "The number one",
    TWO: "A second number"
};

/**
 * Sample.
 * @param {Enumeration} a one of the enumeration values.
 */
Bar.prototype.sample = function(a) {};


b = new Bar();

bar.sample(Enumeration.ONE)

যদিও আপনাকে এটির জন্য কমপক্ষে জাসদককে এনাম ঘোষণা করতে হবে। কোডটি পরিষ্কার এবং আপনি ওয়েবস্টোমে স্বয়ংক্রিয়ভাবে সমাপ্তি লাভ করেন।

একাধিক ফাইল সমস্যা যদিও এইভাবে সমাধান করা যায় না।

Question 3

Jsdoc3 এ 2014 এর শেষ অবধি আপনার লেখার সম্ভাবনা রয়েছে:

/**
 * @param {('rect'|'circle'|'ellipse')} shapeType - The allowed type of the shape
 */
Shape.prototype.getType = function (shapeType) {
  return this.type;
};

অবশ্যই এটি কোনও ডেডিকেটেড এনামের মতো পুনরায় ব্যবহারযোগ্য হবে না তবে অনেক ক্ষেত্রে ডামি এনাম ওভারকিল হয় যদি এটি কেবল একটি ফাংশন দ্বারা ব্যবহৃত হয়।

আরও দেখুন: https://github.com/jsdoc3/jsdoc/issues/629#issue-31314808

Question 4

কি সম্পর্কে:

/**
 * @typedef {"keyvalue" | "bar" | "timeseries" | "pie" | "table"} MetricFormat
 */

/**
 * @param format {MetricFormat}
 */
export function fetchMetric(format) {
    return fetch(`/matric}`, format);
}

Question 5

আমি সেখানে অনুমোদিত মান লেখার একটি আনুষ্ঠানিক উপায় মনে করি না JSDoc ।

আপনি অবশ্যই @param {String('up'|'down'|'left'|'right')}ব্যবহারকারী বি 12 টোস্টারের মতো কিছু লিখতে পারেন ।

কিন্তু, থেকে রেফারেন্স গ্রহণ করে APIDocjs , এখানে কি আমি সীমাবদ্ধ মান লেখা ওরফে জন্য ব্যবহার করেন allowedValues ।

/**
 * Set the arrow position of the tooltip
 * @param {String='up','down','left','right'} position pointer position
 */
setPosition(position='left'){
  // YOUR OWN CODE
}

হ্যাঁ, আমি ES6 ব্যবহার করছি।

Question 6

ক্লোজার সংকলক এটি এইভাবে সমর্থন করে: আপনি একটি সীমাবদ্ধ প্রকার নির্ধারণ করতে "@enum" ব্যবহার করতে পারেন। আপনাকে আসলে এনাম সংজ্ঞাতে মানগুলি সংজ্ঞায়িত করতে হবে না। উদাহরণস্বরূপ, আমি একটি "পূর্ণসংখ্যা" টাইপটিকে সংজ্ঞায়িত করতে পারি:

/** @enum {number} */
var Int = {};

/** @return {Int} */
function toInt(val) {
  return /** @type {Int} */ (val|0);
}

ইনট সাধারণত "সংখ্যা" তে নির্ধারিত হয় (এটি একটি সংখ্যা) তবে "সংখ্যা" কিছু জবরদস্তি (castালাই) ছাড়াই "ইনট" এর জন্য নির্ধারিত হয় না।