version 0.1.3

README.md

@@ -12,7 +12,7 @@ module and using it inside `DefineFunction` initialization code:
 ```typescript
 import { DefineFunction, Schema, SlackFunction } from "deno-slack-sdk/mod.ts";
 // ADD THIS
-import { FunctionSourceFile } from "https://deno.land/x/deno_slack_source_file_resolver@0.1.2/mod.ts";
+import { FunctionSourceFile } from "https://deno.land/x/deno_slack_source_file_resolver@0.1.3/mod.ts";
 
 export const GreetingFunctionDefinition = DefineFunction({
   callback_id: "greeting_function",
@@ -25,7 +25,9 @@ export const GreetingFunctionDefinition = DefineFunction({
 });
 ```
 
-Please note that, when you use this module, **`deno test` command needs to be `deno test --allow-read` instead**. As for running your app by `slack run` and your deployed apps, no extra configuration is requied.
+Please note that, when you use this module, **`deno test` command needs to be
+`deno test --allow-read` instead**. As for running your app by `slack run` and
+your deployed apps, no extra configuration is requied.
 
 ### LICENSE
 

function_source_file.ts

@@ -1,7 +1,10 @@
-export const FunctionSourceFile = function (
-  // Pass the value of import.meta.url in a function code
-  importMetaUrl: string,
-): string {
+/**
+ * Automatically resolves the `source_file` part for `DefineFunction()` in your Slack's next-generation platform app.
+ *
+ * @param importMetaUrl the value of `import.meta.url` in a function code
+ * @returns the relative path from the root directory of your app project
+ */
+export const FunctionSourceFile = function (importMetaUrl: string): string {
   let dirToFindManifestTs = toFilepath(importMetaUrl);
   while (dirToFindManifestTs !== "") {
     const elems = dirToFindManifestTs.split("/");
@@ -19,6 +22,12 @@ export const FunctionSourceFile = function (
   throw new Error(`Failed to resolve source_file path for ${importMetaUrl}`);
 };
 
+/**
+ * Trims the unnecesary parts from import.meta.url to make it valid as a file path.
+ *
+ * @param url `import.meta.url` string value
+ * @returns valid file path
+ */
 function toFilepath(url: string) {
   return url.replace("file://", "");
 }