#APIClient

#نظرة عامة

APIClient هو غلاف مبني على axios، يُستخدم لطلب عمليات موارد NocoBase من جانب العميل عبر HTTP.

#الاستخدام الأساسي

class PluginSampleAPIClient extends Plugin {
  async load() {
    const res = await this.app.apiClient.request({
      // ...
    });
  }
}

#خصائص الكائن

#axios

كائن axios، والذي يمكن استخدامه للوصول إلى واجهة برمجة تطبيقات axios، على سبيل المثال، apiClient.axios.interceptors.

#auth

فئة المصادقة من جانب العميل، راجع Auth.

#storage

فئة التخزين من جانب العميل، راجع Storage.

#دوال الفئة

#constructor()

دالة البناء، تنشئ كائن APIClient.

#التوقيع

• constructor(instance?: APIClientOptions)

#النوع

interface ExtendedOptions {
  authClass?: any;
  storageClass?: any;
}

export type APIClientOptions =
  | AxiosInstance
  | (AxiosRequestConfig & ExtendedOptions);

#request()

تُطلق طلب HTTP.

#التوقيع

• request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D> | ResourceActionOptions): Promise<R>

#النوع

type ResourceActionOptions<P = any> = {
  resource?: string;
  resourceOf?: any;
  action?: string;
  params?: P;
};

#التفاصيل

#AxiosRequestConfig

معلمات طلب axios العامة. راجع Request Config.

const res = await apiClient.request({ url: '' });

#ResourceActionOptions

معلمات طلب عمليات موارد NocoBase.

const res = await apiClient.request({
  resource: 'users',
  action: 'list',
  params: {
    pageSize: 10,
  },
});

| الخاصية | النوع | الوصف ```

#`resource()```

Gets the NocoBase resource action method object.

const resource = apiClient.resource('users');

await resource.create({
  values: {
    username: 'admin',
  },
});

const res = await resource.list({
  page: 2,
  pageSize: 20,
});

#Signature

• resource(name: string, of?: any, headers?: AxiosRequestHeaders): IResource

#Type

export interface ActionParams {
  filterByTk?: any;
  [key: string]: any;
}

type ResourceAction = (params?: ActionParams) => Promise<any>;

export type IResource = {
  [key: string]: ResourceAction;
};

#Details