NPM-pakket — Programmatische API

TypeScript/JavaScript-API-verwijzing voor @microsoft/winappcli. Elke CLI-opdracht is beschikbaar als een asynchrone functie die stdout/stderr vastlegt en een getypt resultaat retourneert. Helperhulpprogramma's voor MSIX-identiteit, Electron-foutopsporingsidentiteit en buildhulpprogramma's worden ook geëxporteerd.

Installatie

npm install @microsoft/winappcli

Snel starten

import { init, packageApp, certGenerate } from '@microsoft/winappcli';

// Initialize a new project with defaults
await init({ useDefaults: true });

// Generate a dev certificate
await certGenerate({ install: true });

// Package the built app
await packageApp({ inputFolder: './dist', cert: './devcert.pfx' });

Algemene typen

Elke CLI-opdrachtwrapper accepteert een optiesobject dat CommonOptions uitbreidt en Promise<WinappResult> retourneert.

`CommonOptions`

Basisopties die worden gedeeld door de meeste opdrachten.

Property	Type	Verplicht	Description
`quiet`	`boolean \\| undefined`	No	Voortgangsberichten onderdrukken.
`verbose`	`boolean \\| undefined`	No	Uitgebreide uitvoer inschakelen.
`cwd`	`string \\| undefined`	No	Werkmap voor het CLI-proces (standaard ingesteld op process.cwd()).

`WinappResult`

Resultaat geretourneerd door elke opdrachtwikkelaar.

Property	Type	Verplicht	Description
`exitCode`	`number`	Yes	Afsluitcode verwerken (altijd 0 bij succes– niet-nul gooien).
`stdout`	`string`	Yes	Vastgelegde standaarduitvoer.
`stderr`	`string`	Yes	Vastgelegde standaardfout.

CLI-opdracht-wrappers

Met deze functies worden systeemeigen winapp CLI-opdrachten verpakt. Alle accepteren CommonOptions (quiet, verbose, cwd).

`certGenerate()`

Maak alleen een zelfondertekend certificaat voor lokaal testen. Publisher moet overeenkomen met het manifest (automatisch afgeleid als --manifest is opgegeven of Package.appxmanifest zich in de werkmap bevindt). Uitvoer: devcert.pfx (standaardwachtwoord: 'wachtwoord'). Haal voor productie een certificaat op bij een vertrouwde CA. Gebruik 'certificaatinstallatie' om te vertrouwen op deze computer.

function certGenerate(options?: CertGenerateOptions): Promise<WinappResult>

Opties:

Property	Type	Verplicht	Description
`exportCer`	`boolean \\| undefined`	No	Een .cer-bestand (alleen openbare sleutel) naast de PFX exporteren
`ifExists`	`IfExists \\| undefined`	No	Gedrag wanneer het uitvoerbestand bestaat: 'error' (falend, standaard), 'skip' (bestaand behouden) ofwel 'overschrijven' (vervangen)
`install`	`boolean \\| undefined`	No	Het certificaat na het genereren installeren in het archief van de lokale computer
`json`	`boolean \\| undefined`	No	Uitvoer opmaken als JSON
`manifest`	`string \\| undefined`	No	Pad naar Package.appxmanifest of appxmanifest.xml-bestand om uitgeversgegevens uit te extraheren
`output`	`string \\| undefined`	No	Uitvoerpad voor het gegenereerde PFX-bestand
`password`	`string \\| undefined`	No	Wachtwoord voor het gegenereerde PFX-bestand
`publisher`	`string \\| undefined`	No	Publisher naam voor het gegenereerde certificaat. Als dit niet is opgegeven, wordt dit afgeleid uit het manifest.
`validDays`	`number \\| undefined`	No	Aantal dagen dat het certificaat geldig is