Skip to content

Commit

Permalink
main 🧊 fix build
Browse files Browse the repository at this point in the history
  • Loading branch information
debabin committed Jun 20, 2024
1 parent 070b0cc commit fff8c34
Show file tree
Hide file tree
Showing 10 changed files with 45 additions and 78 deletions.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,9 @@ features:
- title: usePrevious
details: Hook that returns the previous value
link: /functions/hooks/usePrevious
- title: useQRCode
details: Hook that generates a QR code
link: /functions/hooks/useQRCode
# - title: useQRCode
# details: Hook that generates a QR code
# link: /functions/hooks/useQRCode
- title: useQuery
details: Hook that defines the logic when query data
link: /functions/hooks/useQuery
Expand Down
3 changes: 2 additions & 1 deletion docs/src/utils/parseHookJsdoc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ export const parseHookJsdoc = (file: string) => {
const jsdoc = parse(file)[0];
const description = jsdoc.tags.find(({ tag }) => tag === 'description');
const usage = jsdoc.tags.find(({ tag }) => tag === 'example');
const deprecated = jsdoc.tags.find(({ tag }) => tag === 'deprecated');
const apiParameters = jsdoc.tags.filter(
({ tag }) => tag === 'param' || tag === 'overload' || tag === 'returns'
);

return { description, usage, apiParameters };
return { description, usage, apiParameters, deprecated };
};
10 changes: 4 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,17 @@
},
"peerDependencies": {
"@types/react": "^18.0.0",
"qrcode": "^1.5.3",
"react": "^17.0.2 || ^18.0.0",
"react-dom": "^17.0.2 || ^18.0.0",
"screenfull": "^6.0.2"
"react-dom": "^17.0.2 || ^18.0.0"
},
"peerDependenciesMeta": {
"@types/react": {
"optional": true
}
},
"dependencies": {
"screenfull": "^6.0.2"
},
"devDependencies": {
"@siberiacancode/builder": "^1.3.0",
"@siberiacancode/eslint": "^1.1.0",
Expand All @@ -72,7 +73,6 @@
"@testing-library/react": "^15.0.7",
"@types/doctrine": "^0.0.9",
"@types/node": "^20.11.19",
"@types/qrcode": "^1.5.5",
"@types/react": "^18.3.2",
"@types/react-dom": "^18.3.0",
"comment-parser": "^1.4.1",
Expand All @@ -82,10 +82,8 @@
"husky": "^9.0.11",
"lint-staged": "^15.2.2",
"markdown-table": "^3.0.3",
"qrcode": "^1.5.3",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"screenfull": "^6.0.2",
"shx": "^0.3.4",
"typescript": "^5.3.3",
"vite": "^5.1.3",
Expand Down
1 change: 0 additions & 1 deletion src/hooks/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ export { usePaint } from './usePaint/usePaint';
export { usePreferredColorScheme } from './usePreferredColorScheme/usePreferredColorScheme';
export { usePreferredLanguages } from './usePreferredLanguages/usePreferredLanguages';
export { usePrevious } from './usePrevious/usePrevious';
export { useQRCode } from './useQRCode/useQRCode';
export { useQuery } from './useQuery/useQuery';
export { useQueue } from './useQueue/useQueue';
export { useRenderCount } from './useRenderCount/useRenderCount';
Expand Down
8 changes: 8 additions & 0 deletions src/hooks/useBattery/useBattery.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
import { useEffect, useState } from 'react';

import type { BatteryManager } from '@/utils/types';

declare global {
interface Navigator {
readonly getBattery: () => Promise<BatteryManager>;
}
}

/** State for hook use battery */
interface UseBatteryStateReturn {
/** Is battery API supported? */
Expand Down
11 changes: 11 additions & 0 deletions src/hooks/useEyeDropper/useEyeDropper.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
import { useState } from 'react';

import { isClient } from '@/utils/helpers';
import type {
ColorSelectionOptions,
ColorSelectionResult,
EyeDropperConstructor
} from '@/utils/types';

declare global {
interface Window {
EyeDropper?: EyeDropperConstructor | undefined;
}
}

/** The color selection return type */
export interface UseEyeDropperReturn {
Expand Down
11 changes: 11 additions & 0 deletions src/hooks/useNetwork/useNetwork.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
import { useEffect, useState } from 'react';

import { isClient } from '@/utils/helpers';
import type { Connection } from '@/utils/types';

declare global {
interface Navigator {
readonly connection: Connection;
readonly mozConnection: Connection;
readonly webkitConnection: Connection;
}
}

/** The type of network connection */
export type ConnectionType = Connection['type'];
/** The effective type of connection */
export type ConnectionEffectiveType = Connection['effectiveType'];

/** The use network return type */
Expand Down
16 changes: 0 additions & 16 deletions src/hooks/useQRCode/useQRCode.demo.tsx

This file was deleted.

34 changes: 0 additions & 34 deletions src/hooks/useQRCode/useQRCode.ts

This file was deleted.

23 changes: 6 additions & 17 deletions declarations.d.ts → src/utils/types/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
interface Connection extends EventTarget {
export interface Connection extends EventTarget {
readonly downlink: number;
readonly downlinkMax: number;
readonly effectiveType: 'slow-2g' | '2g' | '3g' | '4g';
Expand All @@ -17,36 +17,25 @@ interface Connection extends EventTarget {
onChange: (event: Event) => void;
}

interface BatteryManager extends EventTarget {
export interface BatteryManager extends EventTarget {
charging: boolean;
chargingTime: number;
dischargingTime: number;
level: number;
}

interface ColorSelectionOptions {
export interface ColorSelectionOptions {
signal?: AbortSignal;
}

interface ColorSelectionResult {
export interface ColorSelectionResult {
sRGBHex: string;
}

interface EyeDropper {
export interface EyeDropper {
open: (options?: ColorSelectionOptions) => Promise<ColorSelectionResult>;
}

interface Navigator {
readonly connection: Connection;
readonly mozConnection: Connection;
readonly webkitConnection: Connection;
readonly getBattery: () => Promise<BatteryManager>;
}

interface EyeDropperConstructor {
export interface EyeDropperConstructor {
new (): EyeDropper;
}

interface Window {
EyeDropper?: EyeDropperConstructor | undefined;
}

0 comments on commit fff8c34

Please sign in to comment.