add docs for the options

aminya · aminya · commit 63f7119a4bc4 · 2020-08-25T09:30:22.000-05:00
diff --git a/src/types/master.ts b/src/types/master.ts
@@ -84,7 +84,9 @@ export interface ThreadsWorkerOptions extends WorkerOptions {
 }
 
 export interface CreateWorkerOptions extends ThreadsWorkerOptions {
-  backend: string
+  /** backend for the threads */
+  backend: "web" | "node" | "tiny"
+  /** flag to return a BlobWorker */
   blob: boolean
 }
 

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,9 @@ export interface ThreadsWorkerOptions extends WorkerOptions {`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`export interface CreateWorkerOptions extends ThreadsWorkerOptions {`
`87`		`- backend: string`
	`87`	`+ /** backend for the threads */`
	`88`	`+ backend: "web" \| "node" \| "tiny"`
	`89`	`+ /** flag to return a BlobWorker */`
`88`	`90`	`blob: boolean`
`89`	`91`	`}`
`90`	`92`