Rename getEntry to getEntryBySlug

[matthewp]

Changes

• Rename getEntry to getEntryBySlug.
  • The new function takes a slug as the second argument instead of an id.
  • It loops over the collection and finds a matching entry that has the provided slug.
• The types here could maybe be better? I could figure out a way to type it so that the provided slug matches an entry with that slug. I think the fact that a slug can be any string is a blocker here. Happy to be proven otherwise.

Testing

• Tests updated

Docs

• PR Rename getEntry to getEntryBySlug docs#2408

[changeset-bot]

🦋 Changeset detected

Latest commit: aa395e4

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[matthewp]

Going to change this to return | undefined so that in SSR you don't have to try/catch.

[bholmesdev]

Just some type cleanup. Some entryguing changes!

[Princesseuh]

Make sure completions still work here. Doing literal unions | string typically break the completions because TypeScript will only see string

You have to do a work around for it to keep the completions, aka | (string & {})

[matthewp]

Ah ok, thank you. I realized that the SSR use-case you're going to be grabbing a string from Astro.params so not allowing any strings would give bad type messages. I'll try your suggestion.

[matthewp]

Ok, updated here: d41cc2f

This works in my testing. If you provide a known slug value you get back just an entry. If you provide any other string you get back an entry or undefined, which is what we want.

[FredKSchott]

LGTM on the API! Thanks for getting this across the line in time for 2.0.

@bholmesdev I'm happy to factor these changes into my docs PR, so no action needed on your part for docs other than giving a review if you can. cc @sarah11918 so she's aware!