@enonic-types/lib-content 0.1.1 → 7.11.0-B3

package/README.md

@@ -5,7 +5,7 @@
 ## Install
 
 ```bash
-npm i --save-dev @enonic/lib-content
+npm i --save-dev @enonic-types/lib-content
 ```
 
 ## Use
@@ -26,8 +26,8 @@ Add the corresponding types to your `tsconfig.json` file that is used for applic
 
 ### Require and custom imports
 
-To make `require` work out of box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP global
-objects, e.g. `log`, `app`, `__`, etc, requiring library by the default path will return typed object.
+To make `require` work out of the box, you must install and add the `@enonic-types/global` types. Aside from providing definitions for XP
+global objects, e.g. `log`, `app`, `__`, etc, requiring a library by the default path will return typed object.
 
 `tsconfig.json`
 
@@ -49,7 +49,7 @@ const {get, query, getChildren} = require('/lib/xp/content');
 ```
 
 More detailed explanation on how it works and how to type custom import function can be
-found [here](https://github.com/enonic/xp/tree/master/modules/lib/typescript/README.md).
+found [here](https://developer.enonic.com/docs/xp/stable/api).
 
 ### ES6-style import
 
@@ -79,3 +79,17 @@ import {get, query, getChildren} from '/lib/xp/content';
 ```
 
 Setting `baseUrl` and `paths` will allow the `tsc` to keep the valid paths in the resulting JavaScript files.
+
+### Additional types
+
+Note that not all types are available for import, but can easily be retrieved from the `Content`: 
+
+```ts
+import type {Content} from '/lib/xp/content';
+
+type Attachments = Content['attachments'];
+
+type ContentInheritType = Content['inherit'];
+
+type Workflow = Content['workflow'];
+```