CommonTypes

internal.internal.CommonTypes

Interfaces

• AddressCreatePayload
• AddressPayload
• BaseEntity
• CustomFindOptions
• DateComparisonOperator
• EmptyQueryParams
• FindConfig
• FindPaginationParams
• FindParams
• NumericalComparisonOperator
• RepositoryTransformOptions
• SoftDeletableEntity
• StringComparisonOperator

References

ConfigModule

Re-exports ConfigModule

---

DeleteResponse

Re-exports DeleteResponse

---

MedusaContainer

Re-exports MedusaContainer

---

PaginatedResponse

Re-exports PaginatedResponse

Type Aliases

ExtendedFindConfig

ExtendedFindConfig<TEntity>: Omit<FindOneOptions<TEntity>, "where" | "relations" | "select"> | Omit<FindManyOptions<TEntity>, "where" | "relations" | "select"> & { order?: FindOptionsOrder<TEntity> ; relations?: FindOptionsRelations<TEntity> ; select?: FindOptionsSelect<TEntity> ; skip?: number ; take?: number ; where: FindOptionsWhere<TEntity> | FindOptionsWhere<TEntity>[] }

Type parameters

TEntityobjectRequired

---

HttpCompressionOptions

HttpCompressionOptions: Object

Type declaration

enabledboolean

levelnumber

memLevelnumber

thresholdnumber | string

---

PartialPick

PartialPick<T, K>: { [P in K]?: T[P] }

Type parameters

TobjectRequired

Kkeyof TRequired

---

ProjectConfigOptions

ProjectConfigOptions: Object

Type declaration

admin_corsstring

cookie_secretstring

database_databasestring

database_extraRecord<string, unknown> & { ssl: { rejectUnauthorized: false } }

database_loggingLoggerOptionsRequired

database_schemastring

database_typestring

database_urlstring

http_compressionHttpCompressionOptions

jwt_secretstring

redis_optionsRedisOptions

redis_prefixstring

redis_urlstring

session_optionsSessionOptions

store_corsstring

---

QueryConfig

QueryConfig<TEntity>: Object

Type parameters

TEntityBaseEntityRequired

Type declaration

allowedFieldsstring[]

allowedRelationsstring[]

defaultFields(keyof TEntity | string)[]

defaultLimitnumber

defaultRelationsstring[]

isListboolean

---

QuerySelector

QuerySelector<TEntity>: Selector<TEntity> & { q?: string }

Type parameters

TEntityobjectRequired

---

RequestQueryFields

RequestQueryFields: Object

Type declaration

expandstring

fieldsstring

limitnumber

offsetnumber

orderstring

---

Selector

Selector<TEntity>: { [key in keyof TEntity]?: TEntity[key] | TEntity[key][] | DateComparisonOperator | StringComparisonOperator | NumericalComparisonOperator | FindOperator<TEntity[key][] | string | string[]\> }

Type parameters

TEntityobjectRequired

---

TotalField

TotalField: "shipping_total" | "discount_total" | "tax_total" | "refunded_total" | "total" | "subtotal" | "refundable_amount" | "gift_card_total" | "gift_card_tax_total"

---

TreeQuerySelector

TreeQuerySelector<TEntity>: QuerySelector<TEntity> & { include_descendants_tree?: boolean }

Type parameters

TEntityobjectRequired

---

WithRequiredProperty

WithRequiredProperty<T, K>: T & { [Property in K]-?: T[Property] }

Utility type used to remove some optional attributes (coming from K) from a type T

Type parameters

TobjectRequired

Kkeyof TRequired

---

Writable

Writable<T>: { -readonly [key in keyof T]: T[key] | FindOperator<T[key]\> | FindOperator<T[key][]\> | FindOperator<string[]\> }

Type parameters

TobjectRequired