Skip to content

Commit e7143f8

Browse files
committed
Update useZendesk types
1 parent d6fd56f commit e7143f8

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

src/useZendesk.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ import ZendeskContext from './ZendeskContext'
44
import fetcher from './libs/fetch'
55
import { API_VERSION } from './constants'
66

7+
/**
8+
* Zendesk Help Center API Hook
9+
*
10+
* @param {Object} props
11+
* @param {string=} props.apiVersion
12+
* @param {string=} props.domain
13+
* @param {string} props.endpoint
14+
* @param {boolean=} props.includeLocale
15+
* @param {string=} props.locale
16+
* @returns
17+
*/
718
const useZendesk = ({
819
apiVersion = API_VERSION,
920
domain,

types/useZendesk.d.ts

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
export default useZendesk;
2+
/**
3+
* Zendesk Help Center API Hook
4+
*
5+
* @param {Object} props
6+
* @param {string=} props.apiVersion
7+
* @param {string=} props.domain
8+
* @param {string} props.endpoint
9+
* @param {boolean=} props.includeLocale
10+
* @param {string=} props.locale
11+
* @returns
12+
*/
213
declare function useZendesk({ apiVersion, domain, endpoint, includeLocale, locale, }: {
3-
apiVersion?: string;
4-
domain: any;
5-
endpoint: any;
6-
includeLocale?: boolean;
7-
locale: any;
14+
apiVersion?: string | undefined;
15+
domain?: string | undefined;
16+
endpoint: string;
17+
includeLocale?: boolean | undefined;
18+
locale?: string | undefined;
819
}): {
920
data: any;
1021
error: any;

0 commit comments

Comments
 (0)