fix(types): adding registerFileHeader type (#722)

Fixes #665
amzn · Oct 28, 2021 · 54332b3 · 54332b3
1 parent 4e3905a
commit 54332b3
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/types/Format.d.ts b/types/Format.d.ts
@@ -44,4 +44,4 @@ export type Formatter = (arguments: FormatterArguments) => string;
 export interface Format {
   name: string;
   formatter: Formatter;
-}
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -163,6 +163,26 @@ declare namespace StyleDictionary {
     */
     registerFilter(filter: Named<Filter>): this;
 
+    /**
+     * Add a custom file header to Style Dictionary. File headers are used to write a
+     * custom messasge on top of the generated files.
+     * @param {String} fileHeader.name The name of the file header to be added
+     * @param {Function} fileHeader.fileHeader The file header function
+     * @example
+     * ```js
+     * StyleDictionary.registerFileHeader({
+     *   name: 'custmoHeader',
+     *   fileHeader: function(defaultMessage) {
+     *      return return [
+     *        `hello`,
+     *        ...defaultMessage
+     *      ]
+     *   }
+     * })
+     * ```
+     */
+     registerFileHeader(fileHeader: Named<{ fileHeader: FileHeader }>): this;
+
     /**
      * Adds a custom parser to parse style dictionary files. This allows you to modify
      * the design token data before it gets to Style Dictionary or write your
@@ -306,4 +326,4 @@ declare namespace StyleDictionary {
 }
 
 declare var StyleDictionary: StyleDictionary.Core;
-export = StyleDictionary;
+export = StyleDictionary;