打字稿省略部分数据的getters setters readOnly？

Question

如何在 Partial<> 数据中省略 getters,setters,methods？

或者存在一种使用打字稿获得这种架构的方法？

我需要一个具有完全访问权限的类型，以及一个没有只读权限的类型。

我试着在这里做一个小例子，见注：//

export const $A = (() => {
    class A {
        _uid?: string = 'generateUID()';
        _title?: string = '';
        children?: A[] = [];
        B?: InstanceType<typeof $B['B']> = $B.create();
        get Title() {
            return this._title || this._uid;
        }
        constructor(data: Partial<A> = {}) {
            Object.assign(this, data);
        }
        getFullTitle() {
            return this._title + this._uid;
        }
    }
    function create(data?: Partial<A>) {
        return new A(data);
    }
    function renderer(A: A) {
        //#1 Allow full access public A in this renderer entity
        const { Title, _title, _uid } = A; // acces all props autorized here
        const fulltitle = A.getFullTitle(); // acces methods autorized here
        const childTitle = A.children[0]?.Title; // acces child props autorized here
    }

    return {
        create,
        renderer,
        A,
    };
})();
export const $B = (() => {
    class B {
        _foo?: string = '';
        get Foo() {
            return this._foo + 'foo';
        }
        constructor(data: Partial<B> = {}) {
            Object.assign(this, data);
        }
    }
    function create(data?: Partial<B>) {
        return new B(data);
    }
    function renderer(B: B) {}

    return {
        create,
        renderer,
        B,
    };
})();

// API
//#2 Partial props only (omit methods,getter,setter) for a higth level API !
$A.create({ Title: '' }); // should not visible and lint error !
$A.create({ getFullTitle: () => '' }); // should not visible and lint error !
// want allow only this structure for higth API
$A.create({
    _title: '',
    _uid: '',
    B: $B.create(),
    children: [$A.create({ _title: '', _uid: '' }), $A.create({ _title: '', _uid: '' })],
});

我想要的是里面 function renderer(A: A) { 能够使用所有 public props methodes，getter，setters。在 function create(data?: Partial<A>) 中只允许部分数据（没有 getters、setters、方法）。

所以我想要一个技巧，当我使用 create() 时，这里只获得黄色道具

我尝试了很多场景都没有成功，总是在某个地方撞墙！如果你有其他人的方式来构建这个？谢谢

Answer 1

据我所知，您无法在类型系统中检测到 getters 或 setter；看到 microsoft/TypeScript#10196 for more information. It is said 那里

Interfaces make no distinction between regular properties and accessor properties--it's an implementation detail left up to the implementer of the interface.

如果要检测值为函数类型的属性，可以使用的答案中的 KeysMatching:

type KeysMatching<T, V> = { [K in keyof T]-?: T[K] extends V ? K : never }[keyof T];

type MethodKeysOfA = KeysMatching<A, Function>;
// type MethodKeysOfA = "getFullTitle"

如果您想检测标记为 readonly 的属性（并且只有 getter 属性算在内），您可以使用答案中的 ReadonlyKeys 来检测:

type IfEquals<X, Y, A = X, B = never> =
    (<T>() => T extends X ? 1 : 2) extends
    (<T>() => T extends Y ? 1 : 2) ? A : B;
type ReadonlyKeys<T> = {
    [P in keyof T]-?: IfEquals<{ [Q in P]: T[P] }, { -readonly [Q in P]: T[P] }, never, P>

type ReadonlyKeysOfA = ReadonlyKeys<A>
// type ReadonlyKeysOfA = "Title"

然后您可以将这些组合起来生成您的“部分”A:

type MyPartialA = Omit<A, MethodKeysOfA | ReadonlyKeysOfA>
/* type MyPartialA = {
     _uid?: string | undefined;
     _title?: string | undefined;
    children?: A[] | undefined;
    B?: B | undefined;
} */

如果您使用 MyPartialA 而不是 Partial<A> 作为 create() 中 data 参数的类型，您会得到您正在寻找的行为：

$A.create({ Title: '' }); // error!
$A.create({ getFullTitle: () => '' }); // error!

$A.create({
    _title: '',
    _uid: '',
    B: $B.create(),
    children: [$A.create({ _title: '', _uid: '' }), $A.create({ _title: '', _uid: '' })],
}); // okay

您也可以将 MyPartialA 视为 A 中的可选属性集。也就是说，您 include 不是 excluding 方法和只读属性，而是 A 中可能不存在的东西。如果是这样，您可以使用 :

答案中的 OptionalKeys 类型

type OptionalKeys<T> = { [K in keyof T]-?:
    ({} extends { [P in K]: T[K] } ? K : never)
}[keyof T];

type OptionalKeysOfA = OptionalKeys<A>;
// type OptionalKeysOfA = "_uid" | "_title" | "children" | "B"

您可以看到这导致了与之前相同的 MyPartialA：

type MyPartialA = Pick<A, OptionalKeysOfA>;
/* type MyPartialA = {
   _uid?: string | undefined;
   _title?: string | undefined;
   children?: A[] | undefined;
   B?: B | undefined;
} */

Playground link to code

打字稿省略部分数据的getters setters readOnly？

Typescript omit getters setters readOnly for Partial data?

javascript

api-design

typescript

entity-component-system