@uppy/core: improve types of .use() (#4882)

This commit is contained in:
Merlijn Vos 2024-01-23 10:03:29 +01:00 committed by GitHub
parent e0186021b8
commit 39e26e7402
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 32 additions and 4 deletions

View file

@ -7,8 +7,10 @@ import assert from 'node:assert'
import fs from 'node:fs'
import path from 'node:path'
import prettierBytes from '@transloadit/prettier-bytes'
import type { Body, Meta } from '@uppy/utils/lib/UppyFile'
import Core from './index.ts'
import UIPlugin from './UIPlugin.ts'
import BasePlugin, { type PluginOpts } from './BasePlugin.ts'
import { debugLogger } from './loggers.ts'
import AcquirerPlugin1 from './mocks/acquirerPlugin1.ts'
import AcquirerPlugin2 from './mocks/acquirerPlugin2.ts'
@ -61,6 +63,33 @@ describe('src/Core', () => {
).toEqual(1)
})
it('should be able to .use() without passing generics again', () => {
interface TestOpts extends PluginOpts {
foo?: string
bar: string
}
class TestPlugin<M extends Meta, B extends Body> extends BasePlugin<
TestOpts,
M,
B
> {
foo: string
constructor(uppy: Core<M, B>, opts: TestOpts) {
super(uppy, opts)
this.id = 'Test'
this.type = 'acquirer'
this.foo = opts?.foo ?? 'bar'
}
}
new Core().use(TestPlugin)
new Core().use(TestPlugin, { foo: '', bar: '' })
// @ts-expect-error boolean not allowed
new Core().use(TestPlugin, { foo: false })
// @ts-expect-error missing option
new Core().use(TestPlugin, { foo: '' })
})
it('should prevent the same plugin from being added more than once', () => {
const core = new Core()
core.use(AcquirerPlugin1)

View file

@ -39,7 +39,6 @@ import locale from './locale.ts'
import type BasePlugin from './BasePlugin.ts'
import type UIPlugin from './UIPlugin.ts'
import type { Restrictions } from './Restricter.ts'
import type { PluginOpts } from './BasePlugin.ts'
type Processor = (fileIDs: string[], uploadID: string) => Promise<void> | void
@ -1663,9 +1662,9 @@ export class Uppy<M extends Meta, B extends Body> {
/**
* Registers a plugin with Core.
*/
use<O extends PluginOpts, I extends UIPlugin<O, M, B> | BasePlugin<O, M, B>>(
Plugin: new (uppy: this, opts?: O) => I,
opts?: O,
use<T extends typeof BasePlugin<any, M, B> | typeof UIPlugin<any, M, B>>(
Plugin: T,
opts?: ConstructorParameters<T>[1],
): this {
if (typeof Plugin !== 'function') {
const msg =