#APIक्लाइंट

#अवलोकन

APIक्लाइंट axios पर आधारित एक रैपर है, जिसका उपयोग क्लाइंट-साइड पर HTTP के माध्यम से NocoBase के रिसोर्स ऑपरेशंस का अनुरोध करने के लिए किया जाता है।

#बुनियादी उपयोग

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

#इंस्टेंस प्रॉपर्टीज़

#axios

यह axios इंस्टेंस है, जिसका उपयोग आप axios API तक पहुँचने के लिए कर सकते हैं, उदाहरण के लिए, apiClient.axios.interceptors.

#auth

क्लाइंट-साइड प्रमाणीकरण क्लास, Auth देखें।

#storage

क्लाइंट-साइड स्टोरेज क्लास, Storage देखें।

#क्लास मेथड्स

#constructor()

कंस्ट्रक्टर, जो एक APIक्लाइंट इंस्टेंस बनाता है।

#सिग्नेचर

• 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 अनुरोध पैरामीटर। अनुरोध कॉन्फ़िग देखें।

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

#ResourceActionOptions

NocoBase रिसोर्स एक्शन अनुरोध पैरामीटर।

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

#resource()

NocoBase रिसोर्स एक्शन मेथड ऑब्जेक्ट प्राप्त करता है।

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

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

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

#सिग्नेचर

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

#टाइप

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

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

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

#विवरण