From 9ea15ceceed92cee123222404d850a397bf9f21c Mon Sep 17 00:00:00 2001
From: Anton Gilgur <agilgur5@gmail.com>
Date: Fri, 17 Jun 2022 19:35:57 -0400
Subject: [PATCH] docs(cache): add a typedoc `@returns` to `createHash` (#361)

- follow-up to my previous commit
  - per comments, this has to be FS-safe, so I thought it would be good to explicitly mention that somewhere
---
 src/tscache.ts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/tscache.ts b/src/tscache.ts
index 85e4852..49dc7b2 100644
--- a/src/tscache.ts
+++ b/src/tscache.ts
@@ -360,6 +360,7 @@ export class TsCache
 		});
 	}
 
+	/** @returns an FS-safe hash string for use as a path to the cached content */
 	private createHash(id: string, snapshot: tsTypes.IScriptSnapshot)
 	{
 		const data = snapshot.getText(0, snapshot.getLength());