• Preparing search index...
  • The search index is not available
lib.reviews
  • lib.reviews
  • dal/lib/create-model
  • defineModel

Function defineModel

  • defineModel<
        Manifest extends
            ModelManifest<
                Record<string, ModelSchemaField<unknown>>,
                boolean,
                EmptyStaticMethods,
                Record<never, InstanceMethod>,
            >,
    >(
        manifest: Manifest,
    ): ModelConstructorWithStatics<Manifest>

    Convenience wrapper around createModelProxy that preserves manifest-derived typing while layering on additional statics in a type-safe manner.

    This is purely a TypeScript ergonomic helper. At runtime it forwards directly to createModelProxy, ensuring the emitted JavaScript stays unchanged.

    Type Parameters

    • Manifest extends ModelManifest<
          Record<string, ModelSchemaField<unknown>>,
          boolean,
          EmptyStaticMethods,
          Record<never, InstanceMethod>,
      >

    Parameters

    • manifest: Manifest

      Model manifest definition

    Returns ModelConstructorWithStatics<Manifest>

    Typed model constructor

    • Defined in dal/lib/create-model.ts:333
  • defineModel<
        Manifest extends
            ModelManifest<
                Record<string, ModelSchemaField<unknown>>,
                boolean,
                EmptyStaticMethods,
                Record<never, InstanceMethod>,
            >,
        ExtraStatics extends Record<string, unknown> = EmptyRecord,
        StaticMethods extends object = EmptyStaticMethods,
        InstanceMethods extends
            Record<string, InstanceMethod> = EmptyInstanceMethods,
    >(
        manifest: Manifest,
        options?: {
            instanceMethods?: InstanceMethods;
            staticMethods?: StaticMethods;
            statics?: ExtraStatics;
        },
    ): ModelConstructorWithStatics<
        MergeManifestMethods<Manifest, StaticMethods, InstanceMethods>,
        ExtraStatics,
    >

    Convenience wrapper around createModelProxy that preserves manifest-derived typing while layering on additional statics in a type-safe manner.

    This is purely a TypeScript ergonomic helper. At runtime it forwards directly to createModelProxy, ensuring the emitted JavaScript stays unchanged.

    Type Parameters

    • Manifest extends ModelManifest<
          Record<string, ModelSchemaField<unknown>>,
          boolean,
          EmptyStaticMethods,
          Record<never, InstanceMethod>,
      >
    • ExtraStatics extends Record<string, unknown> = EmptyRecord
    • StaticMethods extends object = EmptyStaticMethods
    • InstanceMethods extends Record<string, InstanceMethod> = EmptyInstanceMethods

    Parameters

    • manifest: Manifest

      Model manifest definition

    • Optionaloptions: {
          instanceMethods?: InstanceMethods;
          staticMethods?: StaticMethods;
          statics?: ExtraStatics;
      }

    Returns ModelConstructorWithStatics<
        MergeManifestMethods<Manifest, StaticMethods, InstanceMethods>,
        ExtraStatics,
    >

    Typed model constructor

    • Defined in dal/lib/create-model.ts:336

Settings

Member Visibility
lib.reviews
  • Loading...

Generated using TypeDoc