Conversation
The "Exports" table (docs/sdk.md) lists "All types from `types/api.ts`".
`types/api.ts` is an internal file path within the repository. Package consumers import types from the root entry point (`import type { Collection } from "@opensea/cli"`), not from `types/api`- that subpath does not exist in the `package.json` exports. The wording is misleading.
Replaced with "All API response types"- omitting the reference to the internal file to match the style of the other table rows.
Collaborator
|
Thanks @CryptAm. This repo is a read-only mirror of our monorepo, so I recreated your change there in ProjectOpenSea/opensea-devtools#784 (now merged) with you credited as co-author. I adjusted the row slightly to name the import path and an example type: "API response types (e.g. |
Contributor
Author
|
@ryanio |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The "Exports" table (docs/sdk.md) lists "All types from
types/api.ts".types/api.tsis an internal file path within the repository. Package consumers import types from the root entry point (import type { Collection } from "@opensea/cli"), not fromtypes/api- that subpath does not exist in thepackage.jsonexports. The wording is misleading.Solution
Replaced with "All API response types"- omitting the reference to the internal file to match the style of the other table rows.