logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
API Overview

@nocobase/auth

AuthManager
Auth
BaseAuth

@nocobase/cli

NocoBase CLI
Global Environment Variables

@nocobase/client

Application
Plugin

@nocobase/database

Collection
Field

interfaces

BaseInterface
Filter Operators

RelationRepository

BelongsToManyRepository
belongs-to-repository
HasManyRepository
HasOneRepository
Repository

shared

create-options
destroy-options
find-one
find-options
transaction
update-options

@nocobase/flow-engine

DataSourceManager
FlowContext
FlowEngine
FlowModel
FlowResource

@nocobase/server

AppCommand
Application
AuditManager
Context
Migration
Plugin

@nocobase/sdk

Auth
Storage
Previous PageField
Next PageFilter Operators

#BaseInterface

#Overview

BaseInterface is the base class for all Interface types. Users can inherit this class to implement custom Interface logic.

class CustomInterface extends BaseInterface {
  async toValue(value: string, ctx?: any): Promise<any> {
    // Custom toValue logic
  }

  toString(value: any, ctx?: any) {
    // Custom toString logic
  }
}
// Register the Interface
db.interfaceManager.registerInterfaceType('customInterface', CustomInterface)

#API

#toValue(value: string, ctx?: any): Promise

Converts an external string to the actual value of the interface. The value can be directly passed to the Repository for write operations.

#toString(value: any, ctx?: any)

Converts the actual value of the interface to a string type. The string type can be used for exporting or display purposes.