docs

README.md

@@ -146,7 +146,7 @@ window.open(URL.createObjectURL(blob))
 
 ## Types
 
-See the [gif.ts](src/gif.ts)
+See the [types.ts](src/types.ts)
 
 ## Encode Options
 

src/Encoder.ts

@@ -3,7 +3,8 @@ import { Logger } from './Logger'
 import { CropIndexedFrame, EncodeGif, EncodeIndexdFrame, FrameToIndexedFrame } from './transformers'
 import { loadImage, resovleSource } from './utils'
 import { createWorker } from './create-worker'
-import type { EncoderOptions, EncodingFrame, UnencodedFrame } from './types'
+import type { EncoderOptions } from './options'
+import type { EncodingFrame, UnencodedFrame } from './types'
 
 export interface EncoderConfig extends EncoderOptions {
   maxColors: number

src/encode.ts

@@ -1,5 +1,5 @@
 import { Encoder } from './Encoder'
-import type { EncoderOptions } from './types'
+import type { EncoderOptions } from './options'
 
 export function encode(options: EncoderOptions & { format: 'blob' }): Promise<Blob>
 export function encode(options: EncoderOptions & { format?: 'arrayBuffer' }): Promise<ArrayBuffer>

src/options.ts

@@ -0,0 +1,20 @@
+import type { Gif, UnencodedFrame } from './types'
+
+export interface EncoderOptions extends Partial<Omit<Gif, 'width' | 'height' | 'frames'>> {
+  /** GIF width */
+  width: number
+  /** GIF height */
+  height: number
+  /** The frames that needs to be encoded */
+  frames?: Array<UnencodedFrame>
+  /** Enable debug mode to view the execution time log */
+  debug?: boolean
+  /** Worker script url */
+  workerUrl?: string
+  /** Max colors count 2-255 */
+  maxColors?: number
+  /** Palette premultipliedAlpha */
+  premultipliedAlpha?: boolean
+  /** Palette tint */
+  tint?: Array<number>
+}

src/types.ts

@@ -102,22 +102,3 @@ export interface Gif89a extends Gif87a {
 export interface Gif extends Gif89a {
   version: '89a' | '87a'
 }
-
-export interface EncoderOptions extends Partial<Omit<Gif, 'width' | 'height' | 'frames'>> {
-  /** GIF width */
-  width: number
-  /** GIF height */
-  height: number
-  /** The frames that needs to be encoded */
-  frames?: Array<UnencodedFrame>
-  /** Enable debug mode to view the execution time log */
-  debug?: boolean
-  /** Worker script url */
-  workerUrl?: string
-  /** Max colors count 2-255 */
-  maxColors?: number
-  /** Palette premultipliedAlpha */
-  premultipliedAlpha?: boolean
-  /** Palette tint */
-  tint?: Array<number>
-}