mirrors/Bibata_Cursor
1
0
Fork 0
mirror of https://github.com/ful1e5/Bibata_Cursor.git synced 2025-06-08 02:14:54 -04:00
Code Issues Projects Releases Packages Wiki Activity

📚 JSDocs added

Browse source
This commit is contained in:
ful1e5 2020-09-27 16:34:53 +05:30
parent c957fbf177
commit 002bbfdcbd
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
packages/core/src/Schema/SvgDirectoryParser.ts
View file

@ -2,6 +2,12 @@ import fs from "fs";
import path from "path"; import path from "path";
export default class SvgDirectoryParser { export default class SvgDirectoryParser {
/**
*
* Parse the `.svg` files directory.
*
* @param svgDir is relative/absolute path, Where source `.svg` files are stored.
*/
constructor(private svgDir: string) { constructor(private svgDir: string) {
if (!fs.existsSync(this.svgDir)) { if (!fs.existsSync(this.svgDir)) {
throw new Error(`🚨 .svg files not found in ${this.svgDir}`); throw new Error(`🚨 .svg files not found in ${this.svgDir}`);
@ -9,6 +15,7 @@ export default class SvgDirectoryParser {
} }
/** /**
*
* Return all static cursors absolute paths from `svgDir/static` directory. * Return all static cursors absolute paths from `svgDir/static` directory.
*/ */
public getStaticCursors(): string[] { public getStaticCursors(): string[] {
@ -30,8 +37,9 @@ export default class SvgDirectoryParser {
} }
/** /**
* Return all animated cursors absolute paths. *
* Looking inside <svgDir>/animated directory. *
* Return all animated cursors absolute paths from `svgDir/animated` directory.
*/ */
public getAnimatedCursors(): string[] { public getAnimatedCursors(): string[] {
const cursorDir = path.resolve(this.svgDir, "animated"); const cursorDir = path.resolve(this.svgDir, "animated");