Skip to content

Commit

Permalink
Update module-level documentation for preview types
Browse files Browse the repository at this point in the history
Align the text with the module docs for the stable types, clarifying
the updated current status.
  • Loading branch information
chriskrycho committed Nov 22, 2022
1 parent 9294ed8 commit fa3758a
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions types/preview/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
/**
@module
Makes Ember's types for the packages it publishes available by importing this
path from `ember-source`:
Provides stable type definitions for Ember.js. It is maintained by hand, and
the types provided here are unstable and subject to change without warning,
though we make a best effort to keep churn to a minimum while we work to
stabilize Ember's types.
To use these type definitions, add these import to any TypeScript file in your
Ember app or addon:
```ts
import 'ember-source/preview';
import 'ember-source/types';
import 'ember-source/types/preview';
```
As Ember's types become more stable, this will automatically give you the
latest mix of stable and preview types, with no effort from you.
@module
*/

// This works because each of these modules presents `declare module` definition
Expand Down

0 comments on commit fa3758a

Please sign in to comment.