Trying to find a solution for implementing TSDocs with a string literal type declaration in TypeScript.
For instance:
type InputType =
/** Comment should also appear for num1 */
'num1' |
/** Would like the TSDoc to be visible for num2 as well */
'num2'
export const test = (...input: InputType[]) => {
return input
}
tac('num1')
Wanting to display TSDoc comments for 'num1' & 'num2' in tools like VSCode, but currently not working for 'ma1'.
Any ideas on how to achieve this?
Here's an alternative approach you can take:
type NumberType = "firstNumber" | "secondNumber";
/**
*
* @param {"firstNumber"} input description for the second number
*/
function calculate(...input: ["secondNumber", ...string[]]): ["secondNumber"];
/**
*
* @param {"firstNumber"} input description for the first number
*/
function calculate(...input: ["firstNumber", ...string[]]): ["firstNumber"];
/**
*
* @param {string} input description for a custom number
*/
function calculate(...input: [string, ...string[]]): ["customNumber"];
function calculate<T extends NumberType, R extends T[]>(...input: [...R]) {
return input;
}
calculate("num8");
Do you require something similar to this:
/**
* the TSDoc applies to num1
*/
type A = 'num1';
/**
* the TSDoc applies to num2
*/
type B = 'num2';
export const test = (...input: (A | B)[]) => {
return input
}
test('num1');
You may also reference the TypeScript Playground linked here.
When setting up my application, I utilize Restangular.setRequestInterceptor() to trigger a function that displays a loading screen whenever a request is made with Restangular. Yet, there is a specific section in my application where I do not want this fun ...
Currently, I am working on dynamically altering the filterPredicate within MatTableDataSource to enhance basic filtering functionalities. I want to include a fixed condition for text filtering (based on user input in a search field) for two string columns ...
As I work on a website featuring dynamically generated blog posts of varying lengths, I'm looking to restrict the height of each post to 250px. Should a post exceed this limit, I want to truncate it and include a "read more" link that opens a modal ov ...
I've developed a custom npm module that can be used in my applications by including this code snippet in the HTML: <app-header-name></app-header-name> Here is the TypeScript code inside the npm package: import { Component, OnInit } from & ...
While working with mongodb and nodejs to search for data within an embedded document, I encountered a strange issue. The query functions as expected in the database but not when implemented in the actual nodejs code. Below is the structure of my data obje ...
Just starting out with Javascript and Jquery, so please bear with me if this question seems basic I'm dynamically constructing HTML like this: var favoriteresultag = '<ul>'; favoriteresultag += "<section id='"+name+"' ...
I successfully completed an animation using animate(), queue(), and dequeue(). However, I recently discovered that jQuery also offers jquery.queue() or $.queue() and jquery.dequeue() or $.dequeue(). Can anyone assist me in understanding these new terms w ...
Apologies for the basic mistake, but I could really use some assistance with this syntax error. I've spent over an hour searching for it and still haven't been able to locate the issue. It seems to be around the success function(data) section. Th ...
<%- include("partials/header") %> <p> this is main page</p> <% let cpp= 6 %> <% for (let i=0;i<cpp;i++){ %> <div class="card"> <li><%= cards[i].name %></li> <li>< ...
In my x.component.html file, I have a list of objects that are being displayed in Bootstrap cards like this: <div *ngFor="let item of items | async"> <div class="row"> <div class="col-lg-6"> <div class="card ...
I am puzzled by why my inferred types are considered as instances of my more general collection type while my explicit types are not. My goal was to: Have a specific part of my application work with tightly defined collections (e.g., IParents vs IBoss ...
What is the best way to use only native modules in Node.js to recreate functionalities similar to app.listen() and app.get() using http module with a constructor? var app = function(opts) { this.token= opts.token } app.prototype.get = function(call ...
UPDATE: Check out this answer. I have a complex query related to jQuery/JavaScript. I came across a post dealing with a similar issue here, but my code structure is different as it does not involve raw HTML or anchor tags. Essentially, I am working on ...
Currently, I have 8 custom Modals that are called in various places within my app. These modals are currently located inside the app.component.html as shown below: <agc class="app-content" [rows]="'auto 1fr'" [height]=" ...
Illustrate an interface in the following way interface Properties { apple?: string banana?: string cherry?: string date: string } Executing this code works as expected type Sample1 = { [P in keyof Properties]: Properties[P] } const s1: Sample1 ...
I created a simple dropdown using a <div> (parent), <span> (current selection), and <ul> (options) which is functioning properly. Now, I'm looking to enhance it by implementing a feature that allows the dropdown to close when the use ...
Hey there, I've been working on retrieving a Firebase object using Angular and have successfully achieved that. However, I'm now faced with the challenge of how to navigate deeper into the data that is being returned (check out the images linked ...
I've developed this JavaScript code: function PartialViewLoad() { $.ajaxSetup({ cache: false }); $.ajax({ url: "/ControllerAlpha/MethodBeta", type: "GET", dataType: "html", data: { s ...
I am currently exploring the possibility of adding new custom colors to material-ui palette (I am aware that version 4.1 will include this feature, but it is a bit far off in the future). As I am relatively new to typescript, I am finding it challenging t ...
As I develop a CRUD application using express.js and node.js, here is the backend API code that I have written: app.post("/signup", (req, res) => { const { name, email, password } = req.body; if (!name) { res.status(401).json("Please provide a n ...