Jahresrückblick 2025 – unser neuer Blogbeitrag ist online! ✨

[ruhr70]

@AlCalzone:

Vor allem kann es mit https://github.com/ioBroker/ioBroker.javascript/blob/master/lib/javascript.d.ts Autovervollständigung und Typüberprüfung für die Funktionen der ioBroker-Schnittstelle, wenn du am Anfang deines Skripts diesen Kommentar einfügst:

/// <reference path="javascript.d.ts">
// @ts-check</reference>
```` `  

ftp-sync funktioniert, Typcheck auch :-)

Zur Typprüfung habe ich noch eine Frage.

Was machst Du mit Zeilen, in denen Module nachgeladen werden?

Wie:````
const Co2Monitor = require('./co2-monitor');

Hier bekomme ich einen Fehler. Kann man den verhindern?
 ![327_2018-02-10_typ-check.png](/assets/uploads/files/327_2018-02-10_typ-check.png) 

Die globalen Funktionen, die bei mir verwendet werden, habe ich am Ende der Datei ****javascript.d.ts**** hinzugefügt:

function sayit(text: string, vol: number?, instanz?: number): void;
function isTimeInRange(strLower:string, strUpper:string): boolean;
function arbeitstag(): boolean;
function urlaubstag(): boolean;

}

Wahrscheinlicher ist es sinnvoll noch eine zweite Datei anzulegen?

Hier muss ich mir dann noch ansehen, wie die aussehen muss und was ich aus der ****javascript.d.ts**** weglassen kann.

Dann wird ein Fehler bemängelt, bei dem ich nicht nachvollziehen kann, warum:
 ![327_2018-02-10_false.png](/assets/uploads/files/327_2018-02-10_false.png) 

Die beiden ****createState()**** sind doch inhaltlich gleich. Warum erfolgt bei dem letzten ****createState()**** die Fehlermeldung?

[ruhr70]

@AlCalzone:

Anscheinend vergibt ioBroker da noch etwas mehr als meine Definitionen :D `

Bei der Typprüfung erhalte ich noch einen Fehler bei der Verarbeitung eines Objekts, welches die Funktion on() liefert:

Mein Fehler?

Oder muss die Datei zur Typprüfung noch angepasst werden?

[AlCalzone]

Schau ich mir später in Ruhe an. Die Module werden nicht bemängelt wenn du sie in deinem Entwicklungsordner per npm installierst. Wenn du zusätzlich „@types/modulname“ installierst, gibts dafür auch Hilfe.

Gesendet von unterwegs

[AlCalzone]

Ok hab doch noch ein bisschen Leerlauf.

Deine eigenen Funktionen kannst du in einer eigenen .d.ts Datei deklarieren. Im einfachsten Fall reicht für jede Funktion ein „declare function(…): ...“

Oder du machst es ähnlich wie ich mit declare global (aber dann musst du ein Modul wie „fs“ importieren)

Dein zweites createState hat common.type state statt string. Das gibts glaube ich nicht, deswegen wird das Objekt nicht als Partial common erkannt.

Das mit on() hat jemand anders nachgerüstet, das hab ich jetzt nicht im Kopf

Gesendet von unterwegs

[robsdobs]

@ruhe70:Als was verwendest du den das in IOBroker. JavaScript oder Typescript?

Bei Typescript brauchst du die Definition deiner globalen Funktion immer im Script. Oder, wenn es etwas anderes gibt: Ich suche auch noch nach einer besseren Methode.

Das mit dem on hab ich zwar nachgerüstet, aber auch nicht im Kopf. Das sehe ich mir an.

Das hatte ich anhand der verfügbaren Doku erstellt. Vielleicht fehlt noch was. - Bin hier auch nur Anfänger.

[ruhr70]

@AlCalzone:

Schau ich mir später in Ruhe an. Die Module werden nicht bemängelt wenn du sie in deinem Entwicklungsordner per npm installierst. Wenn du zusätzlich „@types/modulname“ installierst, gibts dafür auch Hilfe. `

Ich danke Dir für Deine Hilfe und für Deine Geduld! Du schaffst es allerdings durchaus mich abzuhängen.

Was heißt Entwicklungsordner? Es geht um die Skripte aus ioBroker, welche einmal auf dem ioBroker Ubuntu Rechner und einmal auf meinem Windows 10 Rechner liegen.

Auf dem Windows 10 Rechner habe ich node.js/npm nicht installiert.

Kann man eventuell eine einzelne Zeile von der Typprüfung ausnehmen?

[ruhr70]

@robsdobs:

Als was verwendest du den das in IOBroker. JavaScript oder Typescript?

Bei Typescript brauchst du die Definition deiner globalen Funktion eh immer auch im Script. `

Ich verwende Javascript.

@robsdobs:

Das mit dem on sehe ich mir an. Das hatte ich anhand der verfügbaren Doku erstellt. Vielleicht fehlt noch die ID. `

Danke! :-)

[robsdobs]

also laut https://github.com/ioBroker/ioBroker.javascript/blob/master/doc/en/javascript.md#on–-subscribe-on-changes-or-updates-of-some-state gibt es beim Rückgabetyp für on/subscribe objekt keine id:

{
    	'_id' : 'javascript.0.myplayer',
    	'type' : 'state',
    	'common' : {
    		'def' :    '0',
            'min'  :   '0',
            'max'  :   '6',
    		'type' :   'number',
    		'read' :   'true',
    		'write' :  'true',
    		'states' : '0:stop;1:play;2:pause;3:next;4:previous;5:mute;6:unmute',
    		'role' :   'media.state',
    		'desc' :   'Player handling',
    		'name' :   'MyPlayer'
    	},
    	'native' : {},
    	'channelId' :   'channelID',
    	'channelName' : 'channelName',
    	'deviceId' :    'deviceID',
    	'deviceName' :  'deviceName',
    	'enumIds' : [],
    	'enumNames' : [],
    	'state' : {
    		'val' :  'new state',
    		'ts' :   1416149118,
    		'ack' :  true,
    		'lc' :   1416149118,
    		'from' : 'system.adapter.sonos.0'
    	},
    	'oldState' : {
    		'val' :  'old state',
    		'ts' :   1416148233,
    		'ack' :  true,
    		'lc' :   1416145154,
    		'from' : 'system.adapter.sonos.0'
    	}
    }

Ist kein Problem das hinzu zutragen. Ich würde nur gerne wissen was es da noch alles gibt oder geben kann.

[robsdobs]

ok, ich hab die Änderung im https://github.com/ioBroker/ioBroker.javascript/pull/78 requested.

die geänderte Datei ist https://github.com/robdg80/ioBroker.javascript/blob/patch-1/lib/javascript.d.ts.

Da ist nur das ChangedStateObject geändert. Das kannst du in deine Datei so übernehmen:

		/** Represents the change of a state */
		interface ChangedStateObject extends StateObject {
			common: StateCommon;
			native: Record<string, any="">;
			id?: string;
			name?: string;
			channelId?: string;
			channelName?: string;
   			deviceId?: string;
			deviceName?: string;
			/** The IDs of enums this state is assigned to. For example ["enum.functions.Licht","enum.rooms.Garten"] */
			enumIds? : string[];
			/** The names of enums this state is assigned to. For example ["Licht","Garten"] */
			enumNames? : string[];
			/** new state */
   			state: State;
			/** @deprecated Use state instead **/
			newState: State;
			/** previous state */
			oldState: State;
			/** Name of the adapter instance which set the value, e.g. "system.adapter.web.0" */
			from?: string;
			/** Unix timestamp. Default: current time */
			ts?: number;
			/** Unix timestamp of the last time the value changed */
			lc?: number;
			/** Direction flag: false for desired value and true for actual value. Default: false. */
			ack?: boolean;
		}</string,> 

[ruhr70]

@AlCalzone:

Deine eigenen Funktionen kannst du in einer eigenen .d.ts Datei deklarieren. Im einfachsten Fall reicht für jede Funktion ein „declare function(…): ...“

Oder du machst es ähnlich wie ich mit declare global (aber dann musst du ein Modul wie „fs“ importieren) `

Danke! Ich habe jetzt eine neue Datei javascript-global.d.ts erstellt mit folgendem Inhalt:

import child_process = require("child_process");

type EmptyCallback = () => void;
type ErrorCallback = (err?: string) => void;
type GenericCallback = (err: string | null, result?: T) => void;

// tslint:disable:no-namespace
declare global {

	function sayit(text: string, vol: number?, instanz?: number): void;
	function isTimeInRange(strLower:string, strUpper:string): boolean;
	function arbeitstag(): boolean;
	function urlaubstag(): boolean;
}

Und im Skript:

/// <reference path="../javascript.d.ts">/// <reference path="../javascript-global.d.ts">// @ts-check</reference></reference> 

Das funktioniert jedenfalls.

[ruhr70]

@robsdobs:

ok, ich hab die Änderung im https://github.com/ioBroker/ioBroker.javascript/pull/78 requested.

die geänderte Datei ist https://github.com/robdg80/ioBroker.javascript/blob/patch-1/lib/javascript.d.ts.

Da ist nur das ChangedStateObject geändert. Das kannst du in deine Datei so übernehmen: `

Habe ich gemacht. Die Meldung ist weg.

Super! Danke Dir!

[ruhr70]

@AlCalzone:

Dein zweites createState hat common.type state statt string. Das gibts glaube ich nicht, deswegen wird das Objekt nicht als Partial common erkannt. `

Tomaten auf den Augen. Danke. Da gehört boolean rein. Danke!

Aber da sieht man schön, dass eine Typprüfung sinn macht :-)

[AlCalzone]

@ruhr70:

Danke! Ich habe jetzt eine neue Datei javascript-global.d.ts erstellt mit folgendem Inhalt: `
Die Callback-Typen kannst du weglassen, oder verwendest du die irgendwo anders noch?

[ruhr70]

@AlCalzone:

Die Callback-Typen kannst du weglassen, oder verwendest du die irgendwo anders noch? `

ok. dann kommen die raus.

[ruhr70]

setStateDelayed() müsste wahrscheinlich auch noch angepasst werden:

[robsdobs]

@ruhr70:

setStateDelayed() müsste wahrscheinlich auch noch angepasst werden:

filename="2018-02-11_setStateDelayed.png" index="0">~~ ` Da fehlen vermutlich ein paar Überladungen. Kann ich mir morgen Abend ansehen (wenn nicht AlCalzone schneller ist :))

[AlCalzone]

@ruhr70:

setStateDelayed() müsste wahrscheinlich auch noch angepasst werden: `
https://github.com/ioBroker/ioBroker.javascript/pull/79

Ich hoffe ich hab alle Möglichkeiten erwischt. Mit den 2 boolean-Parametern ist das nämlich nicht eindeutig.

[ruhr70]

@AlCalzone:

@ruhr70:

setStateDelayed() müsste wahrscheinlich auch noch angepasst werden: `
https://github.com/ioBroker/ioBroker.javascript/pull/79

Ich hoffe ich hab alle Möglichkeiten erwischt. Mit den 2 boolean-Parametern ist das nämlich nicht eindeutig. `

Danke! Die Meldungen sind weg :-)

[ruhr70]

@AlCalzone:

Schau ich mir später in Ruhe an. Die Module werden nicht bemängelt wenn du sie in deinem Entwicklungsordner per npm installierst. Wenn du zusätzlich „@types/modulname“ installierst, gibts dafür auch Hilfe. `

@ruhr70:

Ich danke Dir für Deine Hilfe und für Deine Geduld! Du schaffst es allerdings durchaus mich abzuhängen.

Was heißt Entwicklungsordner? Es geht um die Skripte aus ioBroker, welche einmal auf dem ioBroker Ubuntu Rechner und einmal auf meinem Windows 10 Rechner liegen.

Auf dem Windows 10 Rechner habe ich node.js/npm nicht installiert.

Kann man eventuell eine einzelne Zeile von der Typprüfung ausnehmen? `

Darf ich hier noch einmal nachfragen?

Ich bin mit Eurer Hilfe einen Riesenschritt weiter VSCode besser mit ioBroker zu nutzen.

Wo ich noch nicht weiter bin, ist der Punkt mit der Typprüfung eingebundener externer Module in normalen Skripten.

@AlCalzone:

Die Module werden nicht bemängelt wenn du sie in deinem Entwicklungsordner per npm installierst. `

Auch bei normalen Skripten oder nur bei der Adapterentwicklung?

Dann muss ich auf den Windowsrechner auch node.js / npm installieren.

@AlCalzone:

Wenn du zusätzlich „@types/modulname“ installierst, gibts dafür auch Hilfe. `

Danke für die Info!

[AlCalzone]

@ruhr70:

@AlCalzone:

Die Module werden nicht bemängelt wenn du sie in deinem Entwicklungsordner per npm installierst. `

Auch bei normalen Skripten oder nur bei der Adapterentwicklung?

Dann muss ich auf den Windowsrechner auch node.js / npm installieren. `
VSCode kennt den Unterschied zwischen Skripten und Adaptern erst mal nicht - für es sind es einfache js-Dateien bzw. -Projekte.

Wenn du etwas per require einbindest, will es das Modul auch untersuchen - dazu muss entweder das Modul selbst oder seine Typings ("@types/modulname") per npm installiert sein. Du kannst VSCode austricksen, indem du in deiner eigenen d.ts-Datei das Modul deklarierst:

declare module "foo" {
	// ... Funktionen etc.
}

Aber dann wird wieder gemeckert, wenn du eine der Modul-Funktionen verwenden willst und sie nicht deklarierst.

Also entweder: Fehler in require ignorieren, oder NodeJS, npm und Modul bzw. Typings installieren.