diff options
Diffstat (limited to 'std/types/README.md')
| -rw-r--r-- | std/types/README.md | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/std/types/README.md b/std/types/README.md deleted file mode 100644 index d28fd75cb..000000000 --- a/std/types/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# std/types - -Contains type definitions for popular external packages that are compatible with -Deno. - -Because Deno only resolves fully qualified file names, type definitions that -import other type definitions might not work with Deno. Also, when some type -definition supply some global interfaces, they can conflict with Deno. The types -located here have been validated to work with Deno. - -There are several ways these type definitions can be referenced. Likely the -"best" way is that the CDN provider provides a header of `X-TypeScript-Types` -which points to the type definitions. We are working to have this available, but -currently you would need to use the compiler hint of `@deno-types`. For example -to import React: - -```typescript -// @deno-types="https://deno.land/std/types/react/@16.13.1/react.d.ts" -import React from "https://cdn.pika.dev/@pika/react@v16.13.1"; -``` - -or - -```typescript -// @deno-types="https://deno.land/std/types/react/@16.13.1/react.d.ts" -import React from "https://dev.jspm.io/react@16.13.1"; -``` - -#### Notes: - -JSPM transformation of most libraries export everything through the default -namespace, so most of the time it might not be suited to work along with this -definition library. |