[reactive-feathers-state](../README.md) / [types](../modules/types.md) / IFeathersService

# Interface: IFeathersService<IModel, TCustomEventTypes\>

[types](../modules/types.md).IFeathersService

## Type parameters

Name | Default |
------ | ------ |
`IModel` | - |
`TCustomEventTypes` | *unknown* |

## Hierarchy

* **IFeathersService**

## Table of contents

### Methods

- [create](types.ifeathersservice.md#create)
- [find](types.ifeathersservice.md#find)
- [get](types.ifeathersservice.md#get)
- [on](types.ifeathersservice.md#on)
- [patch](types.ifeathersservice.md#patch)
- [remove](types.ifeathersservice.md#remove)
- [removeAllListeners](types.ifeathersservice.md#removealllisteners)
- [update](types.ifeathersservice.md#update)

## Methods

### create

▸ **create**(`payload`: *any*): *Promise*<IModel\>

#### Parameters:

Name | Type |
------ | ------ |
`payload` | *any* |

**Returns:** *Promise*<IModel\>

Defined in: [src/types/index.ts:126](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L126)

___

### find

▸ **find**(`__namedParameters`: { `query`: *Partial*<[*IFeathersQuery*](types.ifeathersquery.md)\>  }): *Promise*<[*IServiceFindResponse*](types.iservicefindresponse.md)<IModel\>\>

#### Parameters:

Name | Type |
------ | ------ |
`__namedParameters` | { `query`: *Partial*<[*IFeathersQuery*](types.ifeathersquery.md)\>  } |

**Returns:** *Promise*<[*IServiceFindResponse*](types.iservicefindresponse.md)<IModel\>\>

Defined in: [src/types/index.ts:124](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L124)

___

### get

▸ **get**(`id`: *string*, `query`: *Partial*<[*IFeathersQuery*](types.ifeathersquery.md)\>): *Promise*<IModel\>

#### Parameters:

Name | Type |
------ | ------ |
`id` | *string* |
`query` | *Partial*<[*IFeathersQuery*](types.ifeathersquery.md)\> |

**Returns:** *Promise*<IModel\>

Defined in: [src/types/index.ts:125](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L125)

___

### on

▸ **on**(`event`: TCustomEventTypes \| *created* \| *patched* \| *removed* \| *updated*, `handler`: (`payload`: *any*) => *any*): *void*

#### Parameters:

Name | Type |
------ | ------ |
`event` | TCustomEventTypes \| *created* \| *patched* \| *removed* \| *updated* |
`handler` | (`payload`: *any*) => *any* |

**Returns:** *void*

Defined in: [src/types/index.ts:130](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L130)

___

### patch

▸ **patch**(`id`: *string*, `payload`: *any*, `query`: *any*): *Promise*<IModel\>

#### Parameters:

Name | Type |
------ | ------ |
`id` | *string* |
`payload` | *any* |
`query` | *any* |

**Returns:** *Promise*<IModel\>

Defined in: [src/types/index.ts:128](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L128)

___

### remove

▸ **remove**(`id`: *string*, `query`: *any*): *Promise*<*any*\>

#### Parameters:

Name | Type |
------ | ------ |
`id` | *string* |
`query` | *any* |

**Returns:** *Promise*<*any*\>

Defined in: [src/types/index.ts:129](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L129)

___

### removeAllListeners

▸ **removeAllListeners**(`event`: TCustomEventTypes \| *created* \| *patched* \| *removed* \| *updated*): *void*

#### Parameters:

Name | Type |
------ | ------ |
`event` | TCustomEventTypes \| *created* \| *patched* \| *removed* \| *updated* |

**Returns:** *void*

Defined in: [src/types/index.ts:131](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L131)

___

### update

▸ **update**(`id`: *string*, `payload`: *any*, `query`: *any*): *Promise*<IModel\>

#### Parameters:

Name | Type |
------ | ------ |
`id` | *string* |
`payload` | *any* |
`query` | *any* |

**Returns:** *Promise*<IModel\>

Defined in: [src/types/index.ts:127](https://github.com/ps73/reactive-feathers-state/blob/aac03ee/src/types/index.ts#L127)