According to the [JSDoc 3 docs](https://jsdoc.app/tags-type.html):
&gt; Arrays and objects (type applications and record types)	
&gt;
&gt;An object with string keys and number values:
&gt; &gt; ``{Object.&lt;string, number&gt;}``

So it would be:

    /** @type {{locales: Object.&lt;string, {name: string, lang: string}&gt;}} */
    var CONF = {
        locales: {
            en: {
                name: &quot;English&quot;,
                lang: &quot;en-US&quot;
            },
            es: {
                name: &quot;Spanish&quot;,
                lang: &quot;es-ES&quot;
            }
        }
    };

Cleaner, using ``@typedef``

    /**
     * @typedef {{name: string, lang: string}} locale
     */
    /**
     * @type {{locales: Object.&lt;string, locale&gt;}}
     */
    var CONF = {
        locales: {
            en: {
                name: &quot;English&quot;,
                lang: &quot;en-US&quot;
            },
            es: {
                name: &quot;Spanish&quot;,
                lang: &quot;es-ES&quot;
            }
        }
    };


As far as I can tell:

Using `@typedef` and `@property` to define a custom type is the &quot;correct&quot; way in JSDoc. But it is cumbersome to write and ugly to read (a cardinal sin in documentation).

The record type is much neater (note the double `{{`s):

       /** {{
             name:string, 
             lang:string
       }} */



I have several strings that look like this:

    &quot;((String1))&quot;

They are all different lengths. How could I remove the parentheses from all these strings in a loop?

How to delete specific characters from a string in Ruby?

I have set up and we are running a default install of GitLab v6.0.1 (we&#39;re about to upgrade as well). It was a &quot;Production&quot; setup, following this guide precisely to the letter:

https://github.com/gitlabhq/gitlabhq/blob/master/doc/install/installation.md

**Now, how do we safely change the URL of a working install?**

Apparently our URL is very long and we&#39;ve come up with a new URL. I&#39;ve edited a number of configuration files and the &quot;Application Status Checks&quot; report everything is OK. I&#39;ve rebooted the server to ensure things are still working.

I can access Nginx just fine, over our original SSL. I can browse the GitLab site, create a repository, etc. I can fork and commit just fine.

It all seems to be OK; but, since this is not a native environment for me, I wanted to double check that I have done everything to rename a GitLab site.

The files I&#39;ve edited are:

    /etc/hosts
      127.0.0.1  localhost
      10.0.0.10  wake.domain.com    wake
      10.0.0.10  git.domain.com     git

    /home/git/gitlab/config/gitlab.yml
      production: &amp;base
        gitlab:
          host: git.domain.com

    /home/git/gitlab-shell/config.yml
      gitlab_url: &quot;https://git.domain.com&quot;
      ^- yes, we are on SSL and that is working, even on a new URL

    /etc/nginx/sites-available/gitlab
      server {
        server_name git.domain.com


How do we change the URL of a working GitLab install?

Having next example:

&lt;!-- language: lang-js --&gt;

    var CONF = {
        locale: {
            &quot;en&quot;: {
                name: &quot;English&quot;,
                lang: &quot;en-US&quot;
            },
            &quot;es&quot;: {
                name: &quot;Spanish&quot;,
                lang: &quot;es-ES&quot;
            }
        }
    };

And knowing that what the locale property contains is a dictionary object, which comes from the database, how can I document its inner properties with JSDoc?

Currently I am thinking to ``typedef``  type for my locale objects, then may I be able to set the ``locale`` property to simply an Array of my defined type? Is this the right way to do it?


How to document a dictionary in JSDoc?

Having next example:

<pre><code class="hljs language-css">var CONF = {
 locale: {
 "en": {
 name: "English",
 lang: "en-US"
 },
 "es": {
 name: "Spanish",
 lang: "es-ES"
 }
 }
};
</code></pre>
And knowing that what the locale property contains is a dictionary object, which comes from the database, how can I document its inner properties with JSDoc?
Currently I am thinking to <code>typedef</code> type for my locale objects, then may I be able to set the <code>locale</code> property to simply an Array of my defined type? Is this the right way to do it?

How can I detect if a user is switching to another browser tab?

Currently, I have this: 

    $(window).on(&quot;blur focus&quot;, function (e) {
    
        var prevType = $(this).data(&quot;prevType&quot;);
    
        if (prevType != e.type) { //  reduce double fire issues
            switch (e.type) {
                case &quot;blur&quot;:
                    $(&#39;.message&#39;).html(&#39;&lt;div class=&quot;alert alert-error&quot;&gt;Oops. You navigated away from the ads &lt;a id=&quot;start&quot; class=&quot;butt green&quot;&gt;Resume&lt;/a&gt;&lt;/div&gt;&#39;);
    
                    var myDiv = $(&quot;#bar&quot;);
                    myDiv.clearQueue();
                    myDiv.stop();
                    clearInterval($timer);
                    $timer = null;
                    break;
                case &quot;focus&quot;:
                    // do work
                    break;
            }
        }
    
        $(this).data(&quot;prevType&quot;, e.type);
    });

			

But that only works when the user is minimizing the active window.

Detect if browser tab is active or user has switched away

So, I&#39;m using this code to open another modal window in a current opened modal window:

    &lt;a onclick=\&quot;$(&#39;#login&#39;).modal(&#39;hide&#39;);$(&#39;#lost&#39;).modal(&#39;show&#39;);\&quot; href=&#39;#&#39;&gt;Click&lt;/a&gt;

What happens is, that for like 500ms the scrollbar will duplicate. I guess because the current modal is still fading out. However it looks very un-smooth and stuttering.

I would appreciate any suggestions to solve this issue. 

Also, is the way building this in an onclick-event unprofessional?

I&#39;m working with the bootstrap version 3.0.

**Edit: I guess it&#39;s neccesary to reduce the time of fading out a modal. How is this possible?**

Bootstrap: Open Another Modal in Modal

I am trying to loop through the following:

    {
        &quot;messages&quot;: [{
            &quot;msgFrom&quot;: &quot;13223821242&quot;,
            &quot;msgBody&quot;: &quot;Hi there&quot;
        }, {
            &quot;msgFrom&quot;: &quot;Bill&quot;,
            &quot;msgBody&quot;: &quot;Hello!&quot;
        }]
    }

I want to retrieve `msgFrom` and `msgBody`

I&#39;ve tried:

			for (var key in data) {
			   var obj = data[key];
			   for (var prop in obj) {
			      if(obj.hasOwnProperty(prop)){
			        console.log(prop + &quot; = &quot; + obj[prop]);
			      }
			   }
			}

But the console log prints `[Object]`

Any ideas what im doing wrong?

How can I loop through a JavaScript object array?

I&#39;m trying to get my function to return the http get request, however, whatever I do it seems to get lost in the ?scope?. I&#39;m quit new to Node.js so any help would be appreciated

    function getData(){
      var http = require(&#39;http&#39;);
      var str = &#39;&#39;;

      var options = {
            host: &#39;www.random.org&#39;,
            path: &#39;/integers/?num=1&amp;min=1&amp;max=10&amp;col=1&amp;base=10&amp;format=plain&amp;rnd=new&#39;
      };

      callback = function(response) {

            response.on(&#39;data&#39;, function (chunk) {
                  str += chunk;
            });

            response.on(&#39;end&#39;, function () {
                  console.log(str);
            });

            //return str;
      }

      var req = http.request(options, callback).end();

      // These just return undefined and empty
      console.log(req.data);
      console.log(str);
    }


How to get data out of a Node.js http get request

In bower (a node dependency package manager), on some dependencies the version is preceded by a tilde.  What does this mean?

    {
        &quot;name&quot;: &quot;mean&quot;,
        &quot;version&quot;: &quot;1.0.0&quot;,
        &quot;dependencies&quot;: {
            &quot;bootstrap&quot;: &quot;3.0.0&quot;,
            &quot;angular&quot;: &quot;~1.0.6&quot;
        }
    {

Bower dependency tilde in Node

In python&#39;s library, we now have two Python Implementation of dictionaries which subclasses `dict` over and above the native `dict` type.

Python&#39;s  advocates have always preferred to `defaultdict` over using `dict.setdefault` where possible. Even the [doc](http://docs.python.org/release/2.5.2/lib/defaultdict-examples.html) quotes that `This technique is simpler and faster than an equivalent technique using dict.setdefault():`

In similar ways, as dictionaries does not maintain order, using `OrderedDict` over using `dict` followed by  sorting the items is preferred when ever possible for the alternative usage. 

In both the above case, the code is definitely cleaner but at the cost of performance penalty. 

While answering and commenting on one of the question [python unique list based on item](https://stackoverflow.com/questions/19626749/python-unique-list-based-on-item/19626840?noredirect=1#comment29138676_19626840), I stumbled upon the performance penalty over the native `dict` when using `defaultdict` and `OrderedDict`. It also seems the size of the data is also not immaterial to the performance advantage `dict` solution has over others. 

I believe `There should be one-- and preferably only one --obvious way to do it.`, so what is the preferred way? 

OrderedDict vs defaultdict vs dict

I have a dictionary with 20 000 plus entries with at the moment simply the unique word and the number of times the word was used in the source text (Dante&#39;s Divine Comedy in Italian).

I would like to work through all entries replacing the value with an actual definition as I find them. Is there a simple way to iterate through the keywords that have as a value a number in order to replace (as I research the meaning)?

The dictionary starts:

    {&#39;corse&#39;: 378, &#39;cielo,&#39;: 209, &#39;mute;&#39;: 16, &#39;torre,&#39;: 11, &#39;corsa&#39;: 53, &#39;assessin&#39;: 21, &#39;corso&#39;: 417, &#39;Tolomea&#39;: 21}  # etc.

Sort of an application that will suggest a keyword to research and define.

Python dictionary replace values

I was wondering if there was a way to initialize a dictionary in python with keys but no corresponding values until I set them. Such as:

    Definition = {&#39;apple&#39;: , &#39;ball&#39;: }

and then later i can set them:

    Definition[key] = something

I only want to initialize keys but I don&#39;t know the corresponding values until I have to set them later. Basically I know what keys I want to add the values as they are found. Thanks.

Initializing a dictionary in python with a key value and no corresponding values

I have only a single key-value pair in a dictionary. I want to assign key to one variable
and it&#39;s value to another variable. I have tried with below ways but I am getting error for same.
 
    &gt;&gt;&gt; d = {&quot;a&quot;: 1}
    
    &gt;&gt;&gt; d.items()
    [(&#39;a&#39;, 1)]
    
    &gt;&gt;&gt; (k, v) = d.items()
    Traceback (most recent call last):
      File &quot;&lt;stdin&gt;&quot;, line 1, in &lt;module&gt;
    ValueError: need more than 1 value to unpack
    
    &gt;&gt;&gt; (k, v) = list(d.items())
    Traceback (most recent call last):
      File &quot;&lt;stdin&gt;&quot;, line 1, in &lt;module&gt;
    ValueError: need more than 1 value to unpack

I know that we can extract key and value one by one, or by for loop and `iteritems()`, but isn&#39;t there a simple way such that we can assign both in a single statement? 


How to extract dictionary single key-value pair in variables

I&#39;m trying to get a pretty print of a dictionary, but I&#39;m having no luck:

    &gt;&gt;&gt; import pprint
    &gt;&gt;&gt; a = {&#39;first&#39;: 123, &#39;second&#39;: 456, &#39;third&#39;: {1:1, 2:2}}
    &gt;&gt;&gt; pprint.pprint(a)
    {&#39;first&#39;: 123, &#39;second&#39;: 456, &#39;third&#39;: {1: 1, 2: 2}}

I wanted the output to be on multiple lines, something like this:

    {&#39;first&#39;: 123,
     &#39;second&#39;: 456,
     &#39;third&#39;: {1: 1,
               2: 2}
    }

Can [`pprint`][1] do this? If not, then which module does it? I&#39;m using [Python 2.7.3][2].


  [1]: https://docs.python.org/2/library/pprint.html
  [2]: https://www.python.org/download/releases/2.7.3/

pprint dictionary on multiple lines

I&#39;ve spent quite a while scouring the internet looking for the best way to properly document callbacks with jsdoc, but unfortunately, I haven&#39;t found a great one yet.

Here&#39;s my question:

I&#39;m writing a Node.js library for developers. This library provides multiple classes, functions, and methods that developers will be working with.

In order to make my code clear and understandable, as well as to (hopefully) auto-generate some API documentation in the future, I&#39;ve started using [jsdoc][1] in my code to self-document what&#39;s happening.

Let&#39;s say I define a function like the following:

    function addStuff(x, y, callback) {
      callback(x+y);
    });

Using jsdoc, I&#39;m currently documenting this function as follows:

    /**
      * Add two numbers together, then pass the results to a callback function.
      *
      * @function addStuff
      * @param {int} x - An integer.
      * @param {int} y - An integer.
      * @param {function} callback - A callback to run whose signature is (sum), where
      *  sum is an integer.
      */
    function addStuff(x, y, callback) {
      callback(x+y);
    });

I feel like the above solution is kinda hack-ish, since there&#39;s no way for me to specify in absolute terms what the callback function should accept.

Ideally, I&#39;d like to do something like:

    /**
      * Add two numbers together, then pass the results to a callback function.
      *
      * @function addStuff
      * @param {int} x - An integer.
      * @param {int} y - An integer.
      * @param {callback} callback - A callback to run.
      * @param {int} callback.sum - An integer.
      */
    function addStuff(x, y, callback) {
      callback(x+y);
    });

The above seems like it&#39;d allow me to more simply convey what my callback needs to accept.  Does that make sense?

I guess my question is simple: what&#39;s the best way to clearly document my callback functions with jsdoc?

Thank you for your time.

  [1]: http://usejsdoc.org/

What&#39;s the proper way to document callbacks with jsdoc?

I&#39;m trying to document an Express middleware, but the build-in validation tool in WebStorm tells me that types are incorrectly assigned in the following JSDoc block:

    /**
     * My middleware.
     *
     * @param {Object} req
     * @param {Object} res
     * @param {Function} next
     * @return {Object}
     */
    exports.show = function(req, res, next) {
        ...
    };

In Express sources, I didn&#39;t find any `@typedef`s to help me. Also, I want to avoid things like `@param {*}`.

What is the correct way to document Express middleware using JSDoc? Thanks for any help.

How to annotate Express middlewares with JSDoc?

How can I tell JSDoc about the structure of an object that is returned. I have found the `@return {{field1: type, field2: type, ...}} description` syntax and tried it:

    /**
     * Returns a coordinate from a given mouse or touch event
     * @param  {TouchEvent|MouseEvent|jQuery.Event} e    
     *         A valid mouse or touch event or a jQuery event wrapping such an
     *         event. 
     * @param  {string} [type=&quot;page&quot;]
     *         A string representing the type of location that should be
     *         returned. Can be either &quot;page&quot;, &quot;client&quot; or &quot;screen&quot;.
     * @return {{x: Number, y: Number}} 
     *         The location of the event
     */
    var getEventLocation = function(e, type) {
        ...
        
        return {x: xLocation, y: yLocation};
    }

While this parses successfully, the resulting documentation simply states:

    Returns: 
        The location of an event
        Type: Object

I am developing an API and need people to know about the object that they will get returned. Is this possible in JSDoc? I am using JSDoc3.3.0-beta1.

JSDoc: Return object structure

All of the official JSDoc examples have naively simple documentation strings, like the following:

    /**
     * @param {string} author - The author of the book.
     */

The problem is, in real-life documentation you often have longer documentation strings:

    /**
     * @param {string} author - The author of the book, presumably some person who writes well
     */

But since most companies (for legitimate readability reasons) have line length limits, the above often isn&#39;t acceptable.  However, what I can&#39;t figure out is what the &quot;right&quot; way of breaking up those lines should be.

I could do:

    /**
     * @param {string} author - The author of the book, presumably some
     * person who writes well
     */

But that is difficult to read.  I could instead do:

    /**
     * @param {string} author - The author of the book, presumably some
     *                          person who writes well
     */

That looks better, but it can result in a ton of lines, especially if the parameter has a long name:

    /**
     * @param {string} personWhoIsTheAuthorOfTheBook - The author of the
     *                                                 book, presumably
     *                                                 some person who
     *                                                 writes well
     */

So my question is, what is the proper/official/canonical way of formatting  long `@param` lines (in the code, not in the generated JSDoc) ... or really any long annotation lines for that matter.

What is the proper/canonical formatting of long JSDoc lines?

I am currently developing a NodeJS project and found out that there is no built in functionality to create JSDoc comments for functions/methods.

I am aware of the TypeScript definitions that exist but I couldn&#39;t really find anything to match what I need.

WebStorm, for example, has some pretty neat JSDoc functionalities. Can one somehow achieve a similar functionality?

Content Type	Original Author	Original Content on Stackoverflow
Question	Áxel Costas Pena	View Question on Stackoverflow
Solution 1 - Javascript	Áxel Costas Pena	View Answer on Stackoverflow
Solution 2 - Javascript	Daniel Winterstein	View Answer on Stackoverflow

How to document a dictionary in JSDoc?

Javascript Problem Overview

Javascript Solutions

Solution 1 - Javascript

Solution 2 - Javascript

How do we change the URL of a working GitLab install?

How to delete specific characters from a string in Ruby?

Attributions