style: add docblock

adonisjs · Aug 27, 2019 · 59c8daf · 59c8daf
1 parent a91f757
commit 59c8daf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/utils.ts b/src/utils.ts
@@ -15,6 +15,9 @@ import * as fileType from 'file-type'
 import * as mediaTyper from 'media-typer'
 import { FileUploadError } from '@ioc:Adonis/Addons/BodyParser'
 
+/**
+ * Attempts to parse the file mime type using the file magic number
+ */
 function parseMimeType (mime): { type: string, subtype: string } | null {
  try {
  const { type, subtype } = mediaTyper.parse(mime)