I'm writing in JS, and I use JSDoc comments to generate both my API documentation and my TypeScript declaration files. However, I have a couple of functions that I'd like to keep out of my TS code -- but I still want to include them in my API reference docs. Is this possible? Is there any sort of tag that tells JSDoc, "document this function but leave it out of the .d.ts file"?
Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
187 Views Asked by alec At
0
There are 0 best solutions below
Related Questions in TYPESCRIPT
- It doesnt always show all the books on my homepage
- S3 integration testing
- Make some of the type's field optional
- storybook 7 does not recognize module declarations
- Page in React only renders elements after refreshing
- Error Inserting into Supabase: Type of 'await' operand must either be a valid promise or must not contain a callable 'then' member
- vscode, debug angular, first time, doesn't debug, 2nd time stops at main.js then it's ok
- Get remote MKV file metadata using nodejs
- Vue/TailwindCSS - Content is behind Sidebar
- TypeScript Error only on big type only when assigned to a variable
- pnpm firebase app "Could not find a declaration file for module 'mime'"
- TypeScript: Type checking while parsing an arbitrary JSON that is typed/
- Issue with BBCode image tag on React
- Typescript: returnType based on value 'single' prop
- Failed to resolve import, but the path is valid, and detected as such by VSCode
Related Questions in JSDOC
- Why does Angular ^17 have problems with my modules, services, etc
- Is there a way to prepend the namespace to the constructor in JSDoc? - e.g. new foo.Bar()
- Automatic JSDoc style comments with last modified time in VScode
- svelte 5 - how to write JSDoc for props
- js-doc merging new properties into existing object type
- How do I import a type definition from a module in JavaScript+JSDoc?
- How to document that a name of a variable can be different in another taxonomy?
- Can VS Code list all JSDoc missing comments?
- JsDoc Typing In FabricJS
- JSDoc create and import type from another file
- JSDoc: Return an object of a certain type from a function by passing a class type to it?
- Extending built-in types in Typescript JSDoc
- How to Document Custom Properties in axiosrequestconfig using jsdoc
- Jsdoc and better-docs for React producing broken links in html docs
- How do I document the useState call using typedoc?
Related Questions in TYPESCRIPT-DECLARATIONS
- How to auto generate d.ts file for a variable in a .ts file?
- What's the difference between declaring a variable and a namespace in a TypeScript declaration file
- How to write path resolutions for assets that require declarations and open the implementation
- Override default lib type in ambient declaration
- Preserve comments for mapped types in d.ts
- Are circular references ok in .d.ts files?
- Derive or infer function argument names and types from object type
- How to force typescript to load .d.ts file containing [declare module ".someExtension"] from npm package (from node_modules directory)
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
- How can I add type declarations to a local non-JavaScript file?
- Return type of function properties in typescript declaration
- Sequelize - Writing model types with .d.ts - everything is optional?
- Why can't an export and a module declaration exist in the same TypeScript declaration file?
- TypeError: Cannot redefine property of extended Array declaration
- Add typings of react-table library to the build using rollup
Related Questions in TYPESCRIPT-DEFINITIONS
- make a d.ts file to only override exported enum and return all other original defs?
- How to specify a monkey patched class in the typescript definitions file?
- How To Create A Parent Constructor That Uses Generics To Allow Object Initialization For Children In Typescript?
- What are the criteria for .d.ts files to be loaded(/when are they loaded) and from what directories?
- Typescript definition file - for a function, return actual property types, or custom property type itself?
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
- ESLint: types for `eslintrc.js`
- Right way to document a custom command with then-functionality
- Is there a way to use generics to type a complex object array that accurately compares a React component and its props type?
- What is the difference between declare var and declare const in typescript definitions?
- Self-referenced type restriction on inferred type argument in Typescript
- Is there a way to partially declare a module in a definition file?
- How to declare, a module.export which exports an array, in a .d.ts file
- Typescript declaration for Node module package
- Polyfill type definitions not getting picked up
Related Questions in API-DOCUMENTATION
- How do I specify language when using OpenAI's Whisper's Python library? And where is its the documentation?
- What is the best API documentation approach for Ballerina record types?
- Where to find a detailed documentation of Superset REST API to create a chart/dashboard?
- Swagger/OAS Schema design discussion
- Large Swagger Json file into multi json files
- How to use swagger with a generic jaxrs api that writes response based on query params and response body is written using response builder class
- Add Custom Text Section in API documentation
- Which approach to choose in API management: "Code first" vs "Spec first"?
- how to customize the swagger UI/OpenApi in spring boot 3 without make my controller look clumsy
- Create custom index.html in asp.net core Redoc as Api-Documentation
- How to describe a model in Swagger for an array with simple objects?
- Redocly OpenAPI structure error. Property `openapi` is not expected here
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
- OpenAPI 3.x.x having different response with the change of Optional Parameters
- How can I show some endpoints only admin
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)
Popular # Hahtags
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?