@stats-organization/github-readme-stats-core 2.1.4 → 2.2.0

package/build/cards/top-languages.d.ts

@@ -1,143 +1,147 @@
-export type Lang = any;
-export type TopLangOptions = any;
-export type Layout = TopLangOptions["layout"];
-export type TopLangData = any;
-/**
- * @typedef {import("../fetchers/types").Lang} Lang
- */
+import type { Lang, TopLangData } from "../fetchers/types.js";
+import type { CommonOptions } from "./common-options.js";
+declare const MIN_CARD_WIDTH = 280;
+type TopLangLayout = "compact" | "normal" | "donut" | "donut-vertical" | "pie";
+interface TopLangOptions extends CommonOptions {
+    hide_title: boolean;
+    card_width: number;
+    hide: Array<string>;
+    layout: TopLangLayout;
+    custom_title: string;
+    langs_count: number;
+    disable_animations: boolean;
+    hide_progress: boolean;
+    hide_values: boolean;
+    prog_bar_bg_color: string;
+    stats_format: "percentages" | "bytes";
+}
 /**
  * Retrieves the programming language whose name is the longest.
  *
- * @param {Lang[]} arr Array of programming languages.
- * @returns {{ name: string, size: number, color: string }} Longest programming language object.
+ * @param arr Array of programming languages.
+ * @returns Longest programming language object.
  */
-export function getLongestLang(arr: Lang[]): {
-    name: string;
-    size: number;
-    color: string;
-};
+declare const getLongestLang: (arr: Array<Lang>) => Pick<Lang, "name" | "size" | "color">;
 /**
  * Convert degrees to radians.
  *
- * @param {number} angleInDegrees Angle in degrees.
- * @returns {number} Angle in radians.
+ * @param angleInDegrees Angle in degrees.
+ * @returns Angle in radians.
  */
-export function degreesToRadians(angleInDegrees: number): number;
+declare const degreesToRadians: (angleInDegrees: number) => number;
 /**
  * Convert radians to degrees.
  *
- * @param {number} angleInRadians Angle in radians.
- * @returns {number} Angle in degrees.
+ * @param angleInRadians Angle in radians.
+ * @returns Angle in degrees.
  */
-export function radiansToDegrees(angleInRadians: number): number;
+declare const radiansToDegrees: (angleInRadians: number) => number;
 /**
  * Convert polar coordinates to cartesian coordinates.
  *
- * @param {number} centerX Center x coordinate.
- * @param {number} centerY Center y coordinate.
- * @param {number} radius Radius of the circle.
- * @param {number} angleInDegrees Angle in degrees.
- * @returns {{x: number, y: number}} Cartesian coordinates.
+ * @param centerX Center x coordinate.
+ * @param centerY Center y coordinate.
+ * @param radius Radius of the circle.
+ * @param angleInDegrees Angle in degrees.
+ * @returns Cartesian coordinates.
  */
-export function polarToCartesian(centerX: number, centerY: number, radius: number, angleInDegrees: number): {
+declare const polarToCartesian: (centerX: number, centerY: number, radius: number, angleInDegrees: number) => {
     x: number;
     y: number;
 };
 /**
  * Convert cartesian coordinates to polar coordinates.
  *
- * @param {number} centerX Center x coordinate.
- * @param {number} centerY Center y coordinate.
- * @param {number} x Point x coordinate.
- * @param {number} y Point y coordinate.
- * @returns {{radius: number, angleInDegrees: number}} Polar coordinates.
+ * @param centerX Center x coordinate.
+ * @param centerY Center y coordinate.
+ * @param x Point x coordinate.
+ * @param y Point y coordinate.
+ * @returns Polar coordinates.
  */
-export function cartesianToPolar(centerX: number, centerY: number, x: number, y: number): {
+declare const cartesianToPolar: (centerX: number, centerY: number, x: number, y: number) => {
     radius: number;
     angleInDegrees: number;
 };
 /**
  * Calculates length of circle.
  *
- * @param {number} radius Radius of the circle.
- * @returns {number} The length of the circle.
+ * @param radius Radius of the circle.
+ * @returns The length of the circle.
  */
-export function getCircleLength(radius: number): number;
+declare const getCircleLength: (radius: number) => number;
 /**
  * Calculates height for the compact layout.
  *
- * @param {number} totalLangs Total number of languages.
- * @returns {number} Card height.
+ * @param totalLangs Total number of languages.
+ * @returns Card height.
  */
-export function calculateCompactLayoutHeight(totalLangs: number): number;
+declare const calculateCompactLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the normal layout.
  *
- * @param {number} totalLangs Total number of languages.
- * @returns {number} Card height.
+ * @param totalLangs Total number of languages.
+ * @returns Card height.
  */
-export function calculateNormalLayoutHeight(totalLangs: number): number;
+declare const calculateNormalLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the donut layout.
  *
- * @param {number} totalLangs Total number of languages.
- * @returns {number} Card height.
+ * @param totalLangs Total number of languages.
+ * @returns Card height.
  */
-export function calculateDonutLayoutHeight(totalLangs: number): number;
+declare const calculateDonutLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the donut vertical layout.
  *
- * @param {number} totalLangs Total number of languages.
- * @returns {number} Card height.
+ * @param totalLangs Total number of languages.
+ * @returns Card height.
  */
-export function calculateDonutVerticalLayoutHeight(totalLangs: number): number;
+declare const calculateDonutVerticalLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the pie layout.
  *
- * @param {number} totalLangs Total number of languages.
- * @returns {number} Card height.
+ * @param totalLangs Total number of languages.
+ * @returns Card height.
  */
-export function calculatePieLayoutHeight(totalLangs: number): number;
+declare const calculatePieLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates the center translation needed to keep the donut chart centred.
- * @param {number} totalLangs Total number of languages.
- * @returns {number} Donut center translation.
+ *
+ * @param totalLangs Total number of languages.
+ * @returns Donut center translation.
  */
-export function donutCenterTranslation(totalLangs: number): number;
+declare const donutCenterTranslation: (totalLangs: number) => number;
 /**
  * Trim top languages to lang_count while also hiding certain languages.
  *
- * @param {Record<string, Lang>} topLangs Top languages.
- * @param {number} langs_count Number of languages to show.
- * @param {string[]=} hide Languages to hide.
- * @returns {{ langs: Lang[], totalLanguageSize: number }} Trimmed top languages and total size.
+ * @param topLangs Top languages.
+ * @param langs_count Number of languages to show.
+ * @param hide Languages to hide.
+ * @returns Trimmed top languages and total size.
  */
-export function trimTopLanguages(topLangs: Record<string, Lang>, langs_count: number, hide?: string[] | undefined): {
-    langs: Lang[];
+declare const trimTopLanguages: (topLangs: TopLangData, langs_count: number, hide?: Array<string>) => {
+    langs: Array<Lang>;
     totalLanguageSize: number;
 };
 /**
- * @typedef {import('../fetchers/types').TopLangData} TopLangData
- */
-/**
- * Renders card that display user's most frequently used programming languages.
+ * Get default languages count for provided card layout.
  *
- * @param {TopLangData} topLangs User's most frequently used programming languages.
- * @param {Partial<TopLangOptions>} options Card options.
- * @returns {string} Language card SVG object.
+ * @param props Function properties.
+ * @param props.layout Input layout string.
+ * @param props.hide_progress Input hide_progress parameter value.
+ * @returns Default languages count for input layout.
  */
-export function renderTopLanguages(topLangs: TopLangData, options?: Partial<TopLangOptions>): string;
-export const MIN_CARD_WIDTH: 280;
+declare const getDefaultLanguagesCountByLayout: ({ layout, hide_progress, }: {
+    layout?: TopLangLayout | undefined;
+    hide_progress?: boolean | undefined;
+}) => number;
 /**
- * Get default languages count for provided card layout.
+ * Renders card that display user's most frequently used programming languages.
  *
- * @param {object} props Function properties.
- * @param {Layout=} props.layout Input layout string.
- * @param {boolean=} props.hide_progress Input hide_progress parameter value.
- * @returns {number} Default languages count for input layout.
+ * @param topLangs User's most frequently used programming languages.
+ * @param options Card options.
+ * @returns Language card SVG object.
  */
-export function getDefaultLanguagesCountByLayout({ layout, hide_progress }: {
-    layout?: Layout | undefined;
-    hide_progress?: boolean | undefined;
-}): number;
+declare const renderTopLanguages: (topLangs: TopLangData, options?: Partial<TopLangOptions>) => string;
+export { getLongestLang, degreesToRadians, radiansToDegrees, polarToCartesian, cartesianToPolar, getCircleLength, calculateCompactLayoutHeight, calculateNormalLayoutHeight, calculateDonutLayoutHeight, calculateDonutVerticalLayoutHeight, calculatePieLayoutHeight, donutCenterTranslation, trimTopLanguages, renderTopLanguages, MIN_CARD_WIDTH, getDefaultLanguagesCountByLayout, };
 //# sourceMappingURL=top-languages.d.ts.map

package/build/cards/top-languages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"top-languages.d.ts","sourceRoot":"","sources":["../../src/cards/top-languages.js"],"names":[],"mappings":";;qBAowBa,cAAc,CAAC,QAAQ,CAAC;;AA3uBrC;;GAEG;AAEH;;;;;GAKG;AACH,oCAHW,IAAI,EAAE,GACJ;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAOvD;AAEH;;;;;GAKG;AACH,iDAHW,MAAM,GACJ,MAAM,CAE4D;AAE/E;;;;;GAKG;AACH,iDAHW,MAAM,GACJ,MAAM,CAE4D;AAE/E;;;;;;;;GAQG;AACH,0CANW,MAAM,WACN,MAAM,UACN,MAAM,kBACN,MAAM,GACJ;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAC,CAQlC;AAED;;;;;;;;GAQG;AACH,0CANW,MAAM,WACN,MAAM,KACN,MAAM,KACN,MAAM,GACJ;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAC,CASpD;AAED;;;;;GAKG;AACH,wCAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,yDAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,wDAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,uDAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,+DAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,qDAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;GAIG;AACH,mDAHW,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;;;GAOG;AACH,2CALW,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,eACpB,MAAM,SACN,MAAM,EAAE,YAAC,GACP;IAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAAC,iBAAiB,EAAE,MAAM,CAAA;CAAE,CA4BxD;AA0mBD;;GAEG;AAEH;;;;;;GAMG;AACH,6CAJW,WAAW,YACX,OAAO,CAAC,cAAc,CAAC,GACrB,MAAM,CAkLlB;AA59BD,6BAAuB,GAAG,CAAC;AA2wB3B;;;;;;;GAOG;AACH,4EAJG;IAAuB,MAAM,GAArB,MAAM,YAAC;IACS,aAAa,GAA7B,OAAO,YAAC;CAChB,GAAU,MAAM,CAclB"}
+{"version":3,"file":"top-languages.d.ts","sourceRoot":"","sources":["../../src/cards/top-languages.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAG9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGzD,QAAA,MAAM,cAAc,MAAM,CAAC;AAW3B,KAAK,aAAa,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,gBAAgB,GAAG,KAAK,CAAC;AAE/E,UAAU,cAAe,SAAQ,aAAa;IAC5C,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,aAAa,GAAG,OAAO,CAAC;CACvC;AAED;;;;;GAKG;AACH,QAAA,MAAM,cAAc,GAClB,KAAK,KAAK,CAAC,IAAI,CAAC,KACf,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAKpC,CAAC;AAEJ;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,gBAAgB,MAAM,KAAG,MACf,CAAC;AAErC;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,gBAAgB,MAAM,KAAG,MACf,CAAC;AAErC;;;;;;;;GAQG;AACH,QAAA,MAAM,gBAAgB,GACpB,SAAS,MAAM,EACf,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,gBAAgB,MAAM,KACrB;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAMxB,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,gBAAgB,GACpB,SAAS,MAAM,EACf,SAAS,MAAM,EACf,GAAG,MAAM,EACT,GAAG,MAAM,KACR;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAO1C,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,MAEzC,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,4BAA4B,GAAI,YAAY,MAAM,KAAG,MAE1D,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,2BAA2B,GAAI,YAAY,MAAM,KAAG,MAEzD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B,GAAI,YAAY,MAAM,KAAG,MAExD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,kCAAkC,GAAI,YAAY,MAAM,KAAG,MAEhE,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,wBAAwB,GAAI,YAAY,MAAM,KAAG,MAEtD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,GAAI,YAAY,MAAM,KAAG,MAEpD,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,gBAAgB,GACpB,UAAU,WAAW,EACrB,aAAa,MAAM,EACnB,OAAO,KAAK,CAAC,MAAM,CAAC,KACnB;IAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAAC,iBAAiB,EAAE,MAAM,CAAA;CAqBjD,CAAC;AA0oBF;;;;;;;GAOG;AACH,QAAA,MAAM,gCAAgC,GAAI,4BAGvC;IACD,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC,KAAG,MAYH,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB,GACtB,UAAU,WAAW,EACrB,UAAS,OAAO,CAAC,cAAc,CAAM,KACpC,MAyKF,CAAC;AAEF,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,4BAA4B,EAC5B,2BAA2B,EAC3B,0BAA0B,EAC1B,kCAAkC,EAClC,wBAAwB,EACxB,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gCAAgC,GACjC,CAAC"}