lol-constants 2.18.0 → 2.19.0

package/core/helpers/isRiotId.d.ts

@@ -0,0 +1,5 @@
+export declare function isRiotId(riotId: any, 
+/** @default '#' */
+splitChar?: string): riotId is string;
+export declare const maxRiotIdNameCharCount: 16;
+export declare const maxRiotIdTagCharCount: 5;

package/core/helpers/isRiotId.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maxRiotIdTagCharCount = exports.maxRiotIdNameCharCount = exports.isRiotId = void 0;
+const splitRiotId_1 = require("./splitRiotId");
+function isRiotId(riotId, 
+/** @default '#' */
+splitChar = '#') {
+    if (typeof riotId != 'string')
+        return false;
+    const id = (0, splitRiotId_1.splitRiotId)(riotId, splitChar);
+    if (id.name == '' || id.name.length > exports.maxRiotIdNameCharCount)
+        return false;
+    if (id.tag == '' || id.tag.length > exports.maxRiotIdTagCharCount)
+        return false;
+    return true;
+}
+exports.isRiotId = isRiotId;
+exports.maxRiotIdNameCharCount = 16;
+exports.maxRiotIdTagCharCount = 5;

package/core/helpers/splitRiotId.d.ts

@@ -0,0 +1,10 @@
+/**
+ * `name#tag` => `{name, tag}`
+ */
+export declare function splitRiotId(riotId: string, 
+/** @default '#' */
+splitChar?: string): SplitRiotId;
+export type SplitRiotId = {
+    name: string;
+    tag: string;
+};

package/core/helpers/splitRiotId.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitRiotId = void 0;
+/**
+ * `name#tag` => `{name, tag}`
+ */
+function splitRiotId(riotId, 
+/** @default '#' */
+splitChar = '#') {
+    const split = riotId.split(splitChar);
+    let name = split[0] ?? '';
+    let tag = split[1] ?? '';
+    if (tag.includes(splitChar))
+        tag = '';
+    return {
+        name,
+        tag,
+    };
+}
+exports.splitRiotId = splitRiotId;

package/core/index.d.ts

@@ -69,6 +69,8 @@ export * from './constants/Spells/SpellKeys';
 export * from './constants/Spells/SpellKeysNum';
 export * from './constants/Spells/SpellNames';
 export * from './helpers/getPositionImageUrl';
+export * from './helpers/isRiotId';
+export * from './helpers/splitRiotId';
 export * from './helpers/Champions/getChampionIdByKey';
 export * from './helpers/Champions/getChampionIdByName';
 export * from './helpers/Champions/getChampionKeyById';

package/core/index.js

@@ -91,6 +91,8 @@ __exportStar(require("./constants/Spells/SpellKeysNum"), exports);
 __exportStar(require("./constants/Spells/SpellNames"), exports);
 // # helpers
 __exportStar(require("./helpers/getPositionImageUrl"), exports);
+__exportStar(require("./helpers/isRiotId"), exports);
+__exportStar(require("./helpers/splitRiotId"), exports);
 // ## Champions
 __exportStar(require("./helpers/Champions/getChampionIdByKey"), exports);
 __exportStar(require("./helpers/Champions/getChampionIdByName"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lol-constants",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "League of Legends constants and data resources, such as champion, item, runes reforged, summoner spells.",
   "main": "core/index.js",
   "types": "core/index.d.ts",