Skip to content

Commit

Permalink
feat(types): export SetupWorkerApi class
Browse files Browse the repository at this point in the history
BREAKING CHANGE: export the SetupWorkerApi class instead of the interface
  • Loading branch information
gduliscouet-ubitransport committed Nov 28, 2022
1 parent ab8b1ac commit 4ef44a9
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 7 deletions.
3 changes: 2 additions & 1 deletion src/index.ts
Expand Up @@ -27,7 +27,8 @@ export { cleanUrl } from './utils/url/cleanUrl'
/**
* Type definitions.
*/
export type { SetupWorkerApi, StartOptions } from './setupWorker/glossary'
export type { SetupWorker, StartOptions } from './setupWorker/glossary'
export { SetupWorkerApi } from './setupWorker/setupWorker'
export type { SharedOptions } from './sharedOptions'

export * from './utils/request/MockedRequest'
Expand Down
2 changes: 1 addition & 1 deletion src/setupWorker/glossary.ts
Expand Up @@ -209,7 +209,7 @@ export type StartHandler = (
) => StartReturnType
export type StopHandler = () => void

export interface SetupWorkerApi {
export interface SetupWorker {
/**
* Registers and activates the mock Service Worker.
* @see {@link https://mswjs.io/docs/api/setup-worker/start `worker.start()`}
Expand Down
8 changes: 5 additions & 3 deletions src/setupWorker/setupWorker.ts
Expand Up @@ -19,15 +19,15 @@ import { createFallbackStop } from './stop/createFallbackStop'
import { devUtils } from '../utils/internal/devUtils'
import { SetupApi } from '../SetupApi'
import { mergeRight } from '../utils/internal/mergeRight'
import { SetupWorkerApi as SetupWorker } from './glossary'
import { SetupWorker } from './glossary'

interface Listener {
target: EventTarget
eventType: string
callback: EventListener
}

class SetupWorkerApi
export class SetupWorkerApi
extends SetupApi<WorkerLifecycleEventsMap>
implements SetupWorker
{
Expand Down Expand Up @@ -225,6 +225,8 @@ class SetupWorkerApi
* @param {RequestHandler[]} handlers List of request handlers.
* @see {@link https://mswjs.io/docs/api/setup-worker `setupWorker`}
*/
export function setupWorker(...handlers: Array<RequestHandler>): SetupWorker {
export function setupWorker(
...handlers: Array<RequestHandler>
): SetupWorkerApi {
return new SetupWorkerApi(...handlers)
}
4 changes: 2 additions & 2 deletions src/setupWorker/start/utils/prepareStartHandler.ts
@@ -1,7 +1,7 @@
import { RequiredDeep } from '../../../typeUtils'
import { mergeRight } from '../../../utils/internal/mergeRight'
import {
SetupWorkerApi,
SetupWorker,
SetupWorkerInternalContext,
StartHandler,
StartOptions,
Expand Down Expand Up @@ -36,7 +36,7 @@ export function resolveStartOptions(
export function prepareStartHandler(
handler: StartHandler,
context: SetupWorkerInternalContext,
): SetupWorkerApi['start'] {
): SetupWorker['start'] {
return (initialOptions) => {
context.startOptions = resolveStartOptions(initialOptions)
return handler(context.startOptions, initialOptions || {})
Expand Down

0 comments on commit 4ef44a9

Please sign in to comment.