Add typescript definition file

[jnpdx]

Summary

This adds an index.d.ts Typescript definition file to the project. The typings are taken either directly from Typescript's inferences of the functions or from React Native's types via @types/react-native

This adds out-of-the-box Typescript support. Note that it does depend on @types/react-native, although I did not add this to peerDependencies since only Typescript users need this and would obviously have it installed already.

Test Plan

What's required for testing (prerequisites)?

Add react-native-hooks to a Typescript enabled React Native project.

What are the steps to reproduce (after prerequisites)?

Typings should be available with all of the same syntax/usage as before.

Compatibility

OS	Implemented
iOS	✅
Android	✅

Checklist

• I have tested this on a device and a simulator
• I added the documentation in README.md
• I mentioned this change in CHANGELOG.md
• I updated the typed files (TS and Flow)
• I added a sample use of the API in the example project (example/App.js)

[paldepind]

The type LayoutRectangle could be imported from react-native and then this could be changed to:

declare function useLayout(): LayoutRectangle & {
  onLayout: (event: {
    nativeEvent: {
      layout: { x: number; y: number; width: number; height: number };
    };
  }) => void;
};

[jnpdx]

Good catch. Updated to use that type both in the nativeEvent as well.

[paldepind]

@jnpdx That's even better 😄

[marnusw]

Since useDeviceOrientation is a concept of this library's own creation and doesn't map directly to RN could we add an exported interface for its return value?

export interface DeviceOrientation {
  portrait?: boolean
  landscape?: boolean
}

declare function useDeviceOrientation(): DeviceOrientation

[jnpdx]

New suggestions from @marnusw implemented

[asurare]

Why is this PR not merged ?

[pvinis]

I'm guessing people are waiting for a move to typescript? We should merge this anyway until this happens. Also I started a PR for a move to typescript and I would appreciate people's help there so we can finish quicker.

#41

[pvinis]

Closing this. Now that we moved to TS, this is generated. Thanks everyone for the input and help!