docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
This commit is contained in:
Shahed Nasser
2023-09-21 20:57:15 +03:00
committed by GitHub
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,151 @@
---
displayed_sidebar: entitiesSidebar
---
# Class: CustomShippingOption
## Hierarchy
- `SoftDeletableEntity`
**`CustomShippingOption`**
## Constructors
### constructor
**new CustomShippingOption**()
#### Inherited from
SoftDeletableEntity.constructor
## Properties
### cart
**cart**: [`Cart`](Cart.md)
#### Defined in
[models/custom-shipping-option.ts:37](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L37)
___
### cart\_id
**cart\_id**: `string`
#### Defined in
[models/custom-shipping-option.ts:33](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L33)
___
### created\_at
**created\_at**: `Date`
#### Inherited from
SoftDeletableEntity.created\_at
#### Defined in
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L16)
___
### deleted\_at
**deleted\_at**: ``null`` \| `Date`
#### Inherited from
SoftDeletableEntity.deleted\_at
#### Defined in
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
___
### id
• **id**: `string`
#### Inherited from
SoftDeletableEntity.id
#### Defined in
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L13)
___
### metadata
• **metadata**: `Record`<`string`, `unknown`\>
#### Defined in
[models/custom-shipping-option.ts:40](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L40)
___
### price
• **price**: `number`
#### Defined in
[models/custom-shipping-option.ts:21](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L21)
___
### shipping\_option
• **shipping\_option**: [`ShippingOption`](ShippingOption.md)
#### Defined in
[models/custom-shipping-option.ts:29](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L29)
___
### shipping\_option\_id
• **shipping\_option\_id**: `string`
#### Defined in
[models/custom-shipping-option.ts:25](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L25)
___
### updated\_at
• **updated\_at**: `Date`
#### Inherited from
SoftDeletableEntity.updated\_at
#### Defined in
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/interfaces/models/base-entity.ts#L19)
## Methods
### beforeInsert
▸ `Private` **beforeInsert**(): `void`
#### Returns
`void`
#### Defined in
[models/custom-shipping-option.ts:42](https://github.com/medusajs/medusa/blob/da7ea8c5d/packages/medusa/src/models/custom-shipping-option.ts#L42)