Service

Overview

The service mixin provides a component with a reactive service prop and a helper method to retrieve the corresponding FeathersJS service instance from the KDK API. It is the foundation for all mixins and components that need to communicate with a backend service.

Usage

import { service } from '@kalisio/kdk/core/client'

export default {
  mixins: [service],
  // ...
}

Props

Prop	Type	Default	Description
service	String	''	The name of the FeathersJS service to target.

Methods

getService()

Retrieves the FeathersJS service instance registered under the service prop name.

• Returns: the FeathersJS service object.
• Throws: Error if no service is found for the given name.

const usersService = this.getService() // equivalent to api.getService(this.service)
const users = await usersService.find({ query: { role: 'admin' } })

TIP

This mixin is a prerequisite for the Object Proxy, Schema Proxy, Base Editor, and Base Viewer mixins.