Skip to content

Commit 0cddd7a

Browse files
committed
docs: no need to export interfaces/classes
1 parent fd7a0cd commit 0cddd7a

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/model-classes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ While [setting up Feathers-Vuex](/getting-started.html#feathers-client-feathers-
1515
```js
1616
import feathersClient, { makeServicePlugin, BaseModel } from '../feathers-client'
1717

18-
export class User extends BaseModel {
18+
class User extends BaseModel {
1919
// Required for $FeathersVuex plugin to work after production transpile.
2020
static modelName = 'User'
2121
// Define default properties here
@@ -61,10 +61,10 @@ By default, Model classes are `string` indexable with value of type `any`. This
6161

6262
```ts
6363
// Just like before, we define our class as an extension of BaseModel
64-
export class User extends BaseModel { /* ... */ }
64+
class User extends BaseModel { /* ... */ }
6565

6666
// Augment the User Model interface
67-
export interface User {
67+
interface User {
6868
email: string
6969
password: string
7070
}
@@ -76,7 +76,7 @@ If you already have a User interface defined under a different name, just define
7676

7777
```ts
7878
// if our User interface already exists as UserRecord
79-
export interface User extends UserRecord {}
79+
interface User extends UserRecord {}
8080
```
8181

8282
To further enhance typing, you can augment FeathersVuex types to aid development in other parts of your app. It's important to note the differences in the following example if you do or do not setup a `serverAlias`.
@@ -85,8 +85,8 @@ To further enhance typing, you can augment FeathersVuex types to aid development
8585
// src/store/user.store.ts
8686
import { ServiceState } from 'feathers-vuex'
8787

88-
export class User extends BaseModel { /* ... */ }
89-
export interface User { /* ... */ }
88+
class User extends BaseModel { /* ... */ }
89+
interface User { /* ... */ }
9090
const servicePath = 'users'
9191

9292
declare module "feathers-vuex" {

0 commit comments

Comments
 (0)