get-startappsdeprecated

Dependency-free promise based wrapper for the Powershell Get-StartApps command.

Install & Usage example

npm install get-startapps

Look for all the Xbox app :

const ps = require('get-startapps');

ps("Xbox").then((result)=>{

  console.log(result);
  
  /* OUTPUT
[ { name: ' Xbox Game Bar',
    appid: ' Microsoft.XboxGamingOverlay_8wekyb3d8bbwe!App' },
  { name: ' Xbox Console Companion',
    appid: ' Microsoft.XboxApp_8wekyb3d8bbwe!Microsoft.XboxApp' } ] 
  */

}).catch((err)=>{
  console.error(err);
});

List them all :

const ps = require('get-startapps');

ps().then((result)=>{

  console.log(result);
  
  /* OUTPUT
 [{ name: ' Google Chrome', appid: ' Chrome' },
  { name: ' GitHub Desktop', appid: ' com.squirrel.GitHubDesktop.GitHubDesktop' }, 
      ... 335 more items ]
  */

}).catch((err)=>{
  console.error(err);
});

Has GamingOverlay (Microsoft.XboxGamingOverlay_8wekyb3d8bbwe!App) ? :

const ps = require('get-startapps');

ps.has({id:"GamingOverlay"}).then((result)=>{

  console.log(result); // true or false

}).catch((err)=>{
  console.error(err);
});

Is "Microsoft.WindowsStore_8wekyb3d8bbwe!App" a valid UWP Application User Model ID ?

const { isValidAUMID } = require('get-startapps');

console.log(isValidAUMID("Microsoft.WindowsStore_8wekyb3d8bbwe!App")); //true 

API

• (default) async(string||object search = {}) array[{},...]

Parameters:

• a string => equivalent of Get-StartApps then search all the result for matching result name or appid.
• an object {name: "xxx", id: "yyy"} => Use Powershell to search for either matching name, appid or both.
• Nothing/Empty object => equivalent of Get-StartApps : List all available apps.

Returns:

An array of object :

[  { name: '',
    appid: '' }, ... ]

On error returns an empty array.

Example:

const ps = require('get-startapps');

await ps("Xbox"); //string
await ps({name:"Game Bar",id:"GamingOverlay"}); //object both properties
await ps({name:"Microsoft"}); //object by name only
await ps({id:"Xbox"}); //object by id only
await ps(); //nothing list all

• has = async(string||object search = {}) bol

Parameters:

• a string => equivalent of Get-StartApps then search all the result for matching result name or appid.
• an object {name: "xxx", id: "yyy"} => Use Powershell to search for either matching name, appid or both.

Returns:

true/false

On error or unvalid parameters returns false.

Example:

const ps = require('get-startapps');

await ps.has("Xbox"); //string
await ps.has({id:"GamingOverlay", name: "Game Bar"}); //object both properties
await ps.has({id:"GamingOverlay"}); //object by name only
await ps.has({name:"Game Bar"}); //object by id only

• isValidAUMID = (string appID) bol

Check if appID is a valid UWP Application User Model ID.

Returns:

true/false

Error if appID isn't a string.

Example:

const { isValidAUMID } = require('get-startapps');

console.log(isValidAUMID("Microsoft.WindowsStore_8wekyb3d8bbwe!App")); //true
console.log(isValidAUMID("com.squirrel.GitHubDesktop.GitHubDesktop")); //false