diff --git a/README.md b/README.md index 83961cc..cfae228 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > Easy as hooks that integrate with the [pusher-js](https://github.com/pusher/pusher-js) library. -[![NPM](https://img.shields.io/npm/v/react-pusher-hooks.svg)](https://www.npmjs.com/package/react-pusher-hooks) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) +[![NPM](https://img.shields.io/npm/v/use-pusher.svg)](https://www.npmjs.com/package/react-pusher-hooks) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) ## Install @@ -10,6 +10,8 @@ yarn add use-pusher ``` +##### [API Reference/Docs](https://mayteio.github.io/use-pusher/) + ## Usage You must wrap your app with a `PusherProvider` and pass it config props for [pusher-js](https://github.com/pusher/pusher-js) initialisation initialisation. @@ -134,10 +136,6 @@ const Example = () => { This project was built using typescript, so types are built-in. Yeeeew! -## API Reference - -TODO - ## License MIT © [@mayteio](https://github.com/@mayteio) diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 6a900d5..3c29e05 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2097152":"Object literal"},"rows":[{"id":0,"kind":1,"name":"\"helpers\"","url":"modules/_helpers_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":64,"name":"useDeepCompareMemoize","url":"modules/_helpers_.html#usedeepcomparememoize","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"helpers\""},{"id":2,"kind":1,"name":"\"types\"","url":"modules/_types_.html","classes":"tsd-kind-external-module"},{"id":3,"kind":256,"name":"PusherContextValues","url":"interfaces/_types_.pushercontextvalues.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":4,"kind":1024,"name":"client","url":"interfaces/_types_.pushercontextvalues.html#client","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherContextValues"},{"id":5,"kind":1024,"name":"triggerEndpoint","url":"interfaces/_types_.pushercontextvalues.html#triggerendpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherContextValues"},{"id":6,"kind":1024,"name":"pusherOptions","url":"interfaces/_types_.pushercontextvalues.html#pusheroptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherContextValues"},{"id":7,"kind":256,"name":"PusherProviderProps","url":"interfaces/_types_.pusherproviderprops.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":8,"kind":1024,"name":"clientKey","url":"interfaces/_types_.pusherproviderprops.html#clientkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":9,"kind":1024,"name":"cluster","url":"interfaces/_types_.pusherproviderprops.html#cluster","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types\".PusherProviderProps"},{"id":10,"kind":1024,"name":"authEndpoint","url":"interfaces/_types_.pusherproviderprops.html#authendpoint","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types\".PusherProviderProps"},{"id":11,"kind":1024,"name":"auth","url":"interfaces/_types_.pusherproviderprops.html#auth","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types\".PusherProviderProps"},{"id":12,"kind":1024,"name":"triggerEndpoint","url":"interfaces/_types_.pusherproviderprops.html#triggerendpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":13,"kind":1024,"name":"children","url":"interfaces/_types_.pusherproviderprops.html#children","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":14,"kind":1024,"name":"forceTLS","url":"interfaces/_types_.pusherproviderprops.html#forcetls","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":15,"kind":1024,"name":"encrypted","url":"interfaces/_types_.pusherproviderprops.html#encrypted","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":16,"kind":1024,"name":"authTransport","url":"interfaces/_types_.pusherproviderprops.html#authtransport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":17,"kind":1024,"name":"authorizer","url":"interfaces/_types_.pusherproviderprops.html#authorizer","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":18,"kind":1024,"name":"disableStats","url":"interfaces/_types_.pusherproviderprops.html#disablestats","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":19,"kind":1024,"name":"enabledTransports","url":"interfaces/_types_.pusherproviderprops.html#enabledtransports","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":20,"kind":1024,"name":"disabledTransports","url":"interfaces/_types_.pusherproviderprops.html#disabledtransports","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":21,"kind":1024,"name":"ignoreNullOrigin","url":"interfaces/_types_.pusherproviderprops.html#ignorenullorigin","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":22,"kind":1024,"name":"activityTimeout","url":"interfaces/_types_.pusherproviderprops.html#activitytimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":23,"kind":1024,"name":"pongTimeout","url":"interfaces/_types_.pusherproviderprops.html#pongtimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":24,"kind":1024,"name":"wsHost","url":"interfaces/_types_.pusherproviderprops.html#wshost","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":25,"kind":1024,"name":"wsPath","url":"interfaces/_types_.pusherproviderprops.html#wspath","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":26,"kind":1024,"name":"wsPort","url":"interfaces/_types_.pusherproviderprops.html#wsport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":27,"kind":1024,"name":"wssPort","url":"interfaces/_types_.pusherproviderprops.html#wssport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":28,"kind":1024,"name":"httpHost","url":"interfaces/_types_.pusherproviderprops.html#httphost","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":29,"kind":1024,"name":"httpPort","url":"interfaces/_types_.pusherproviderprops.html#httpport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":30,"kind":1024,"name":"httpsPort","url":"interfaces/_types_.pusherproviderprops.html#httpsport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":31,"kind":256,"name":"useChannelOptions","url":"interfaces/_types_.usechanneloptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":32,"kind":1024,"name":"skip","url":"interfaces/_types_.usechanneloptions.html#skip","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".useChannelOptions"},{"id":33,"kind":1,"name":"\"PusherProvider\"","url":"modules/_pusherprovider_.html","classes":"tsd-kind-external-module"},{"id":34,"kind":32,"name":"__PusherContext","url":"modules/_pusherprovider_.html#__pushercontext","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":35,"kind":32,"name":"__PusherConsumer","url":"modules/_pusherprovider_.html#__pusherconsumer","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":36,"kind":64,"name":"PusherProvider","url":"modules/_pusherprovider_.html#pusherprovider","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":37,"kind":1,"name":"\"usePusher\"","url":"modules/_usepusher_.html","classes":"tsd-kind-external-module"},{"id":38,"kind":64,"name":"usePusher","url":"modules/_usepusher_.html#usepusher","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"usePusher\""},{"id":39,"kind":1,"name":"\"useChannel\"","url":"modules/_usechannel_.html","classes":"tsd-kind-external-module"},{"id":40,"kind":64,"name":"useChannel","url":"modules/_usechannel_.html#usechannel","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"useChannel\""},{"id":41,"kind":1,"name":"\"useTrigger\"","url":"modules/_usetrigger_.html","classes":"tsd-kind-external-module"},{"id":42,"kind":64,"name":"useTrigger","url":"modules/_usetrigger_.html#usetrigger","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"useTrigger\""},{"id":43,"kind":1,"name":"\"index\"","url":"modules/_index_.html","classes":"tsd-kind-external-module"},{"id":44,"kind":1,"name":"\"mocks\"","url":"modules/_mocks_.html","classes":"tsd-kind-external-module"},{"id":45,"kind":128,"name":"ChannelMock","url":"classes/_mocks_.channelmock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":46,"kind":2097152,"name":"binding","url":"classes/_mocks_.channelmock.html#binding","classes":"tsd-kind-object-literal tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":47,"kind":32,"name":"eventType","url":"classes/_mocks_.channelmock.html#binding.eventtype","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"mocks\".ChannelMock.binding"},{"id":48,"kind":32,"name":"onEvent","url":"classes/_mocks_.channelmock.html#binding.onevent","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"mocks\".ChannelMock.binding"},{"id":49,"kind":1024,"name":"emit","url":"classes/_mocks_.channelmock.html#emit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":50,"kind":1024,"name":"bind","url":"classes/_mocks_.channelmock.html#bind","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":51,"kind":1024,"name":"unbind","url":"classes/_mocks_.channelmock.html#unbind","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":52,"kind":128,"name":"PusherMock","url":"classes/_mocks_.pushermock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":53,"kind":1024,"name":"clientKey","url":"classes/_mocks_.pushermock.html#clientkey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":54,"kind":1024,"name":"config","url":"classes/_mocks_.pushermock.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":55,"kind":512,"name":"constructor","url":"classes/_mocks_.pushermock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":56,"kind":1024,"name":"subscribe","url":"classes/_mocks_.pushermock.html#subscribe","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":57,"kind":1024,"name":"unsubscribe","url":"classes/_mocks_.pushermock.html#unsubscribe","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2097152":"Object literal"},"rows":[{"id":0,"kind":1,"name":"\"types\"","url":"modules/_types_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"PusherContextValues","url":"interfaces/_types_.pushercontextvalues.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":2,"kind":1024,"name":"client","url":"interfaces/_types_.pushercontextvalues.html#client","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherContextValues"},{"id":3,"kind":1024,"name":"triggerEndpoint","url":"interfaces/_types_.pushercontextvalues.html#triggerendpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherContextValues"},{"id":4,"kind":1024,"name":"pusherOptions","url":"interfaces/_types_.pushercontextvalues.html#pusheroptions","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherContextValues"},{"id":5,"kind":256,"name":"PusherProviderProps","url":"interfaces/_types_.pusherproviderprops.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":6,"kind":1024,"name":"clientKey","url":"interfaces/_types_.pusherproviderprops.html#clientkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":7,"kind":1024,"name":"cluster","url":"interfaces/_types_.pusherproviderprops.html#cluster","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types\".PusherProviderProps"},{"id":8,"kind":1024,"name":"authEndpoint","url":"interfaces/_types_.pusherproviderprops.html#authendpoint","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types\".PusherProviderProps"},{"id":9,"kind":1024,"name":"auth","url":"interfaces/_types_.pusherproviderprops.html#auth","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite","parent":"\"types\".PusherProviderProps"},{"id":10,"kind":1024,"name":"triggerEndpoint","url":"interfaces/_types_.pusherproviderprops.html#triggerendpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":11,"kind":1024,"name":"children","url":"interfaces/_types_.pusherproviderprops.html#children","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":12,"kind":1024,"name":"forceTLS","url":"interfaces/_types_.pusherproviderprops.html#forcetls","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":13,"kind":1024,"name":"encrypted","url":"interfaces/_types_.pusherproviderprops.html#encrypted","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":14,"kind":1024,"name":"authTransport","url":"interfaces/_types_.pusherproviderprops.html#authtransport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":15,"kind":1024,"name":"authorizer","url":"interfaces/_types_.pusherproviderprops.html#authorizer","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":16,"kind":1024,"name":"disableStats","url":"interfaces/_types_.pusherproviderprops.html#disablestats","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":17,"kind":1024,"name":"enabledTransports","url":"interfaces/_types_.pusherproviderprops.html#enabledtransports","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":18,"kind":1024,"name":"disabledTransports","url":"interfaces/_types_.pusherproviderprops.html#disabledtransports","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":19,"kind":1024,"name":"ignoreNullOrigin","url":"interfaces/_types_.pusherproviderprops.html#ignorenullorigin","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":20,"kind":1024,"name":"activityTimeout","url":"interfaces/_types_.pusherproviderprops.html#activitytimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":21,"kind":1024,"name":"pongTimeout","url":"interfaces/_types_.pusherproviderprops.html#pongtimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":22,"kind":1024,"name":"wsHost","url":"interfaces/_types_.pusherproviderprops.html#wshost","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":23,"kind":1024,"name":"wsPath","url":"interfaces/_types_.pusherproviderprops.html#wspath","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":24,"kind":1024,"name":"wsPort","url":"interfaces/_types_.pusherproviderprops.html#wsport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":25,"kind":1024,"name":"wssPort","url":"interfaces/_types_.pusherproviderprops.html#wssport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":26,"kind":1024,"name":"httpHost","url":"interfaces/_types_.pusherproviderprops.html#httphost","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":27,"kind":1024,"name":"httpPort","url":"interfaces/_types_.pusherproviderprops.html#httpport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":28,"kind":1024,"name":"httpsPort","url":"interfaces/_types_.pusherproviderprops.html#httpsport","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":29,"kind":256,"name":"useChannelOptions","url":"interfaces/_types_.usechanneloptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":30,"kind":1024,"name":"skip","url":"interfaces/_types_.usechanneloptions.html#skip","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".useChannelOptions"},{"id":31,"kind":1,"name":"\"PusherProvider\"","url":"modules/_pusherprovider_.html","classes":"tsd-kind-external-module"},{"id":32,"kind":32,"name":"__PusherContext","url":"modules/_pusherprovider_.html#__pushercontext","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":33,"kind":32,"name":"__PusherConsumer","url":"modules/_pusherprovider_.html#__pusherconsumer","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":34,"kind":64,"name":"PusherProvider","url":"modules/_pusherprovider_.html#pusherprovider","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":35,"kind":1,"name":"\"mocks\"","url":"modules/_mocks_.html","classes":"tsd-kind-external-module"},{"id":36,"kind":128,"name":"ChannelMock","url":"classes/_mocks_.channelmock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":37,"kind":2097152,"name":"binding","url":"classes/_mocks_.channelmock.html#binding","classes":"tsd-kind-object-literal tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":38,"kind":32,"name":"eventType","url":"classes/_mocks_.channelmock.html#binding.eventtype","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"mocks\".ChannelMock.binding"},{"id":39,"kind":32,"name":"onEvent","url":"classes/_mocks_.channelmock.html#binding.onevent","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"mocks\".ChannelMock.binding"},{"id":40,"kind":1024,"name":"emit","url":"classes/_mocks_.channelmock.html#emit","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":41,"kind":1024,"name":"bind","url":"classes/_mocks_.channelmock.html#bind","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":42,"kind":1024,"name":"unbind","url":"classes/_mocks_.channelmock.html#unbind","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".ChannelMock"},{"id":43,"kind":128,"name":"PusherMock","url":"classes/_mocks_.pushermock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":44,"kind":1024,"name":"clientKey","url":"classes/_mocks_.pushermock.html#clientkey","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":45,"kind":1024,"name":"config","url":"classes/_mocks_.pushermock.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":46,"kind":512,"name":"constructor","url":"classes/_mocks_.pushermock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":47,"kind":1024,"name":"subscribe","url":"classes/_mocks_.pushermock.html#subscribe","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":48,"kind":1024,"name":"unsubscribe","url":"classes/_mocks_.pushermock.html#unsubscribe","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":49,"kind":1,"name":"\"usePusher\"","url":"modules/_usepusher_.html","classes":"tsd-kind-external-module"},{"id":50,"kind":64,"name":"usePusher","url":"modules/_usepusher_.html#usepusher","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"usePusher\""},{"id":51,"kind":1,"name":"\"useChannel\"","url":"modules/_usechannel_.html","classes":"tsd-kind-external-module"},{"id":52,"kind":64,"name":"useChannel","url":"modules/_usechannel_.html#usechannel","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"useChannel\""},{"id":53,"kind":1,"name":"\"useTrigger\"","url":"modules/_usetrigger_.html","classes":"tsd-kind-external-module"},{"id":54,"kind":64,"name":"useTrigger","url":"modules/_usetrigger_.html#usetrigger","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"useTrigger\""}]}; \ No newline at end of file diff --git a/docs/classes/_mocks_.channelmock.html b/docs/classes/_mocks_.channelmock.html index 4c558fb..5a2a6c8 100644 --- a/docs/classes/_mocks_.channelmock.html +++ b/docs/classes/_mocks_.channelmock.html @@ -106,7 +106,7 @@

bind

bind: Mock<void, [string, any]> = jest.fn((eventName: string, onEvent: any) => {this.binding.onEvent = onEvent;this.binding.eventType = eventName;})
@@ -116,7 +116,7 @@

emit

emit: Mock<void, [string, any]> = jest.fn((eventName: string, data: any) => {if (this.binding.onEvent !== undefined &&this.binding.eventType === eventName) {this.binding.onEvent(data);}})
@@ -126,7 +126,7 @@

unbind

unbind: Mock<void, []> = jest.fn(() => {this.binding.onEvent = undefined;this.binding.eventType = undefined;})
@@ -139,7 +139,7 @@

binding

binding: object
@@ -148,7 +148,7 @@

eventType

eventType: undefined = undefined
@@ -158,7 +158,7 @@

onEvent

onEvent: undefined = undefined
@@ -174,12 +174,6 @@

onEvent

  • "PusherProvider"
    • -
  • - "helpers" -
    • -
  • - "index" -
  • "mocks"
    • diff --git a/docs/classes/_mocks_.pushermock.html b/docs/classes/_mocks_.pushermock.html index 3a2a417..2b5e2d9 100644 --- a/docs/classes/_mocks_.pushermock.html +++ b/docs/classes/_mocks_.pushermock.html @@ -111,7 +111,7 @@

    constructor

  • Parameters

    @@ -136,7 +136,7 @@

    clientKey

    clientKey: undefined | string
    @@ -146,7 +146,7 @@

    config

    config: undefined | Config
    @@ -156,7 +156,7 @@

    subscribe

    subscribe: Mock<ChannelMock, []> = jest.fn(() => new ChannelMock())
    @@ -166,7 +166,7 @@

    unsubscribe

    unsubscribe: Mock<any, any> = jest.fn()
    @@ -181,12 +181,6 @@

    unsubscribe

  • "PusherProvider"
    • -
  • - "helpers" -
    • -
  • - "index" -
  • "mocks"
    • diff --git a/docs/globals.html b/docs/globals.html index 41750d0..7e089e4 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -71,8 +71,6 @@

    Index

    External modules