Type autocompletions via JSDoc

[binarious]

I tried to get autocompletions via JSDoc type with typescript-language-server to work without success:

const { Item } = require('openhab');

// ...

/** @param {Item} item */
function queryState(item) {
  const host = item.getMetadata('host').value;
}

In this example item doesn't get autocompletion, but items.getItem('...').getMe... does. I also tried @param {items.Item} item or @param {typeof items.Item} item without success.

Any ideas?

[florian-h05]

Your import of Item is wrong and won't work.
Always have a look at the docs, they will tell you how to import correctly: https://github.com/openhab/openhab-js#standard-library.

This code will work:

const { Item } = require('openhab').items;

/**
 * 
 * @param {Item} item 
 */
function queryState (item) {
  const host = item.getMetadata('host').value;
}

[binarious]

Thanks, this actually works. I was expected const { items } = require('openhab'); and @param {items.Item} item to also work, but it doesn't seem to be the case.

[florian-h05]

I am not sure why items.Item doesn’t work. You could use a import(‚openhab/items/items‘).Item inside the JSDoc type brackets.