Skip to content

docs: Document shared packages owned by a module #757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
marcelomendoncasoares wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Document shared packages owned by a module #757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/06-concepts/03-data-and-the-database/01-models/05-shared-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,17 @@ fields:
sharedModels: List<SharedModel>
```

## Shared packages in a module

A [module](../../server-fundamentals/modules) declares its shared packages the same way, in its own `config/generator.yaml`:

```yaml
shared_packages:
- ../my_module_shared
```

Projects that install the module reach those models through `my_module_server` and `my_module_client`, so they need no dependency on the shared package itself.

## Restrictions

Shared models support most Serverpod model features, with these exceptions:
Expand Down
Loading