cody-music - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

dist/lib/apis.d.ts

@@ -34,5 +34,5 @@ import { PlayerName, Track, PlayerDevice, SpotifyAudioFeature } from "./models";
  **/
-export declare function getRunningPlayerState(): Promise<Track>;
+export declare function getRunningTrack(): Promise<Track>;
 /**
- * Returns the player state and track of a given player {spotify|spotify-web|itunes}
+ * Returns the track of a given player {spotify|spotify-web|itunes}
  * - Spotify does not return a "genre"
@@ -43,3 +43,3 @@ * - duration is in milliseconds
  */
-export declare function getPlayerState(player: PlayerName): Promise<Track>;
+export declare function getTrack(player: PlayerName): Promise<Track>;
 /**
@@ -185,32 +185,36 @@ * Returns the tracks that are found by the given playlist name
 /**
- * Deprecated - use "getRunningPlayerState()" instead
+ * Deprecated - use "getTrack(player)"
  */
+export declare function getPlayerState(player: PlayerName): Promise<Track>;
+/**
+ * Deprecated - use "getRunningTrack()" instead
+ */
 export declare function getCurrentlyRunningTrackState(): Promise<Track>;
 /**
- * deprecated, please use "getPlayerState"
+ * Deprecated - please use "getPlayerState"
  */
 export declare function getState(player: PlayerName): Promise<Track>;
 /**
- * deprecated, please use "launchPlayer('spotify')"
+ * Deprecated - please use "launchPlayer('spotify')"
  **/
 export declare function startSpotifyIfNotRunning(): Promise<any>;
 /**
- * deprecated, please use "launchPlayer('itunes')"
+ * Deprecated - please use "launchPlayer('itunes')"
  */
 export declare function startItunesIfNotRunning(): Promise<any>;
 /**
- * deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+ * Deprecated - please use "isSpotifyRunning" or "isItunesRunning"
  */
 export declare function isRunning(player: PlayerName): Promise<boolean>;
 /**
- * deprecated, pluse use "setRepat(player, repeat)"
+ * Deprecated - please use "setRepat(player, repeat)"
  */
 export declare function repeatOn(player: PlayerName): Promise<any>;
 /**
- * deprecated, pluse use "setRepat(player, repeat)"
+ * Deprecated - please use "setRepat(player, repeat)"
  */
 export declare function repeatOff(player: PlayerName): Promise<any>;
 /**
- * deprecated, pluse use "unmute(player)"
+ * Deprecated - please use "unmute(player)"
  */
 export declare function unMute(player: PlayerName): Promise<any>;

dist/lib/apis.js

@@ -70,14 +70,14 @@ "use strict";
  **/
-async function getRunningPlayerState() {
+async function getRunningTrack() {
     if (await musicCtr.isMusicPlayerActive(models_1.PlayerName.SpotifyDesktop)) {
-        return getPlayerState(models_1.PlayerName.SpotifyDesktop);
+        return getTrack(models_1.PlayerName.SpotifyDesktop);
     }
     else if (await musicCtr.isMusicPlayerActive(models_1.PlayerName.ItunesDesktop)) {
-        return getPlayerState(models_1.PlayerName.ItunesDesktop);
+        return getTrack(models_1.PlayerName.ItunesDesktop);
     }
-    return getPlayerState(models_1.PlayerName.SpotifyWeb);
+    return getTrack(models_1.PlayerName.SpotifyWeb);
 }
-exports.getRunningPlayerState = getRunningPlayerState;
+exports.getRunningTrack = getRunningTrack;
 /**
- * Returns the player state and track of a given player {spotify|spotify-web|itunes}
+ * Returns the track of a given player {spotify|spotify-web|itunes}
  * - Spotify does not return a "genre"
@@ -88,3 +88,3 @@ * - duration is in milliseconds
  */
-async function getPlayerState(player) {
+async function getTrack(player) {
     let track;
@@ -111,3 +111,3 @@ if (player === models_1.PlayerName.SpotifyWeb) {
 }
-exports.getPlayerState = getPlayerState;
+exports.getTrack = getTrack;
 /**
@@ -386,17 +386,24 @@ * Returns the tracks that are found by the given playlist name
 /**
- * Deprecated - use "getRunningPlayerState()" instead
+ * Deprecated - use "getTrack(player)"
  */
+function getPlayerState(player) {
+    return getTrack(player);
+}
+exports.getPlayerState = getPlayerState;
+/**
+ * Deprecated - use "getRunningTrack()" instead
+ */
 function getCurrentlyRunningTrackState() {
-    return musicPlayerCtr.getCurrentlyRunningTrackState();
+    return musicPlayerCtr.getCurrentlyRunningTrack();
 }
 exports.getCurrentlyRunningTrackState = getCurrentlyRunningTrackState;
 /**
- * deprecated, please use "getPlayerState"
+ * Deprecated - please use "getPlayerState"
  */
 function getState(player) {
-    return getPlayerState(player);
+    return getTrack(player);
 }
 exports.getState = getState;
 /**
- * deprecated, please use "launchPlayer('spotify')"
+ * Deprecated - please use "launchPlayer('spotify')"
  **/
@@ -408,3 +415,3 @@ function startSpotifyIfNotRunning() {
 /**
- * deprecated, please use "launchPlayer('itunes')"
+ * Deprecated - please use "launchPlayer('itunes')"
  */
@@ -416,3 +423,3 @@ function startItunesIfNotRunning() {
 /**
- * deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+ * Deprecated - please use "isSpotifyRunning" or "isItunesRunning"
  */
@@ -424,3 +431,3 @@ function isRunning(player) {
 /**
- * deprecated, pluse use "setRepat(player, repeat)"
+ * Deprecated - please use "setRepat(player, repeat)"
  */
@@ -432,3 +439,3 @@ function repeatOn(player) {
 /**
- * deprecated, pluse use "setRepat(player, repeat)"
+ * Deprecated - please use "setRepat(player, repeat)"
  */
@@ -440,3 +447,3 @@ function repeatOff(player) {
 /**
- * deprecated, pluse use "unmute(player)"
+ * Deprecated - please use "unmute(player)"
  */
@@ -443,0 +450,0 @@ function unMute(player) {

dist/lib/playerstate.d.ts

@@ -6,3 +6,3 @@ import { PlayerDevice, Track, PlayerContext, SpotifyAudioFeature } from "./models";
     static getInstance(): MusicPlayerState;
-    getCurrentlyRunningTrackState(): Promise<Track>;
+    getCurrentlyRunningTrack(): Promise<Track>;
     isWindowsSpotifyRunning(): Promise<boolean>;
@@ -9,0 +9,0 @@ isSpotifyDesktopRunning(): Promise<boolean>;

dist/lib/playerstate.js

@@ -22,3 +22,3 @@ "use strict";
     }
-    async getCurrentlyRunningTrackState() {
+    async getCurrentlyRunningTrack() {
         let trackState = new models_1.Track();
@@ -25,0 +25,0 @@ let spotifyDesktopRunning = await this.isSpotifyDesktopRunning();

lib/apis.ts

@@ -77,13 +77,13 @@ "use strict";
  **/
-export async function getRunningPlayerState(): Promise<Track> {
+export async function getRunningTrack(): Promise<Track> {
     if (await musicCtr.isMusicPlayerActive(PlayerName.SpotifyDesktop)) {
-        return getPlayerState(PlayerName.SpotifyDesktop);
+        return getTrack(PlayerName.SpotifyDesktop);
     } else if (await musicCtr.isMusicPlayerActive(PlayerName.ItunesDesktop)) {
-        return getPlayerState(PlayerName.ItunesDesktop);
+        return getTrack(PlayerName.ItunesDesktop);
     }
-    return getPlayerState(PlayerName.SpotifyWeb);
+    return getTrack(PlayerName.SpotifyWeb);
 }
 
 /**
- * Returns the player state and track of a given player {spotify|spotify-web|itunes}
+ * Returns the track of a given player {spotify|spotify-web|itunes}
  * - Spotify does not return a "genre"
@@ -94,3 +94,3 @@ * - duration is in milliseconds
  */
-export async function getPlayerState(player: PlayerName): Promise<Track> {
+export async function getTrack(player: PlayerName): Promise<Track> {
     let track;
@@ -400,17 +400,24 @@ if (player === PlayerName.SpotifyWeb) {
 /**
- * Deprecated - use "getRunningPlayerState()" instead
+ * Deprecated - use "getTrack(player)"
  */
+export function getPlayerState(player: PlayerName): Promise<Track> {
+    return getTrack(player);
+}
+
+/**
+ * Deprecated - use "getRunningTrack()" instead
+ */
 export function getCurrentlyRunningTrackState(): Promise<Track> {
-    return musicPlayerCtr.getCurrentlyRunningTrackState();
+    return musicPlayerCtr.getCurrentlyRunningTrack();
 }
 
 /**
- * deprecated, please use "getPlayerState"
+ * Deprecated - please use "getPlayerState"
  */
 export function getState(player: PlayerName): Promise<Track> {
-    return getPlayerState(player);
+    return getTrack(player);
 }
 
 /**
- * deprecated, please use "launchPlayer('spotify')"
+ * Deprecated - please use "launchPlayer('spotify')"
  **/
@@ -422,3 +429,3 @@ export function startSpotifyIfNotRunning() {
 /**
- * deprecated, please use "launchPlayer('itunes')"
+ * Deprecated - please use "launchPlayer('itunes')"
  */
@@ -430,3 +437,3 @@ export function startItunesIfNotRunning() {
 /**
- * deprecated, please use "isSpotifyRunning" or "isItunesRunning"
+ * Deprecated - please use "isSpotifyRunning" or "isItunesRunning"
  */
@@ -438,3 +445,3 @@ export function isRunning(player: PlayerName): Promise<boolean> {
 /**
- * deprecated, pluse use "setRepat(player, repeat)"
+ * Deprecated - please use "setRepat(player, repeat)"
  */
@@ -446,3 +453,3 @@ export function repeatOn(player: PlayerName) {
 /**
- * deprecated, pluse use "setRepat(player, repeat)"
+ * Deprecated - please use "setRepat(player, repeat)"
  */
@@ -454,3 +461,3 @@ export function repeatOff(player: PlayerName) {
 /**
- * deprecated, pluse use "unmute(player)"
+ * Deprecated - please use "unmute(player)"
  */
@@ -457,0 +464,0 @@ export function unMute(player: PlayerName) {

lib/playerstate.ts

@@ -32,3 +32,3 @@ import { MusicUtil } from "./util";
 
-    async getCurrentlyRunningTrackState(): Promise<Track> {
+    async getCurrentlyRunningTrack(): Promise<Track> {
         let trackState: Track = new Track();
@@ -35,0 +35,0 @@ let spotifyDesktopRunning = await this.isSpotifyDesktopRunning();

package.json

 {
     "name": "cody-music",
-    "version": "1.3.1",
+    "version": "1.3.2",
     "description": "mac osx spotify and itunes music player controller, spotify audio features, itunes and spotify genre, and playlist control",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -111,3 +111,3 @@ # cody-music
  */
-getPlayerState(player: PlayerName): Promise<Track>
+getTrack(player: PlayerName): Promise<Track>
 
@@ -292,3 +292,6 @@ /**
 
-// deprecated, please use "getPlayerState"
+// deprecated, please use "getTrack"
+getPlayerState(player: PlayerName): Promise<Track>
+
+// deprecated, please use "getTrack"
 getState(player: PlayerName): Promise<Track>
@@ -305,9 +308,9 @@
 
-// deprecated, pluse use "setRepat(player, repeat)"
+// deprecated, please use "setRepat(player, repeat)"
 repeatOn(player: PlayerName)
 
-// deprecated, pluse use "setRepat(player, repeat)"
+// deprecated, please use "setRepat(player, repeat)"
 repeatOff(player: PlayerName)
 
-// deprecated, pluse use "unmute(player)"
+// deprecated, please use "unmute(player)"
 unMute(player: PlayerName)
@@ -314,0 +317,0 @@ ```

No alert changes

Improved metrics

Total package byte prevSize

223862

increased by0.15%

Lines of code

5288

increased by0.32%

Number of lines in readme file

321

increased by0.94%

No dependency changes