Skip to content

docs(seo-graph-core): clarify buildPiece takes no IdFactory #52

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

Open
schlessera wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(seo-graph-core): clarify buildPiece takes no IdFactory #52

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
6 changes: 4 additions & 2 deletions packages/seo-graph-core/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,10 @@ missing pieces during development.

### Piece builders

All builders take an input object and the `IdFactory`, and return a plain
object with `@type` and `@id`. Builders for CreativeWork subtypes (`WebSite`,
The dedicated builders take an input object and the `IdFactory`, and return a
plain object with `@type` and `@id`. `buildPiece` is the exception: it takes
only the input object — pass `@id` and `@type` inline in that object. Builders
for CreativeWork subtypes (`WebSite`,
`WebPage`, `Article`) share a common set of optional fields via
`CreativeWorkFields`: `description`, `inLanguage`, `datePublished`,
`dateModified`, `about`, `copyrightHolder`, `copyrightYear`,
Expand Down