diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index 10307e5..579619d 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","2048":"Method","65536":"Type 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":256,"name":"PusherProviderProps","url":"interfaces/_types_.pusherproviderprops.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":5,"kind":1024,"name":"clientKey","url":"interfaces/_types_.pusherproviderprops.html#clientkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":6,"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":7,"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":8,"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":9,"kind":1024,"name":"triggerEndpoint","url":"interfaces/_types_.pusherproviderprops.html#triggerendpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":10,"kind":1024,"name":"defer","url":"interfaces/_types_.pusherproviderprops.html#defer","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":"value","url":"interfaces/_types_.pusherproviderprops.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":13,"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":14,"kind":1024,"name":"enableStats","url":"interfaces/_types_.pusherproviderprops.html#enablestats","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":15,"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":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":"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":"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":"encrypted","url":"interfaces/_types_.pusherproviderprops.html#encrypted","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":21,"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":22,"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":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":"statsHost","url":"interfaces/_types_.pusherproviderprops.html#statshost","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":25,"kind":1024,"name":"timelineParams","url":"interfaces/_types_.pusherproviderprops.html#timelineparams","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":26,"kind":1024,"name":"unavailable_timeout","url":"interfaces/_types_.pusherproviderprops.html#unavailable_timeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":27,"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":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":"wsPath","url":"interfaces/_types_.pusherproviderprops.html#wspath","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":30,"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":31,"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":32,"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":33,"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":34,"kind":256,"name":"useChannelOptions","url":"interfaces/_types_.usechanneloptions.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":35,"kind":1024,"name":"skip","url":"interfaces/_types_.usechanneloptions.html#skip","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".useChannelOptions"},{"id":36,"kind":1,"name":"\"PusherProvider\"","url":"modules/_pusherprovider_.html","classes":"tsd-kind-external-module"},{"id":37,"kind":32,"name":"PusherContext","url":"modules/_pusherprovider_.html#pushercontext","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"PusherProvider\""},{"id":38,"kind":32,"name":"__PusherContext","url":"modules/_pusherprovider_.html#__pushercontext","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":39,"kind":64,"name":"PusherProvider","url":"modules/_pusherprovider_.html#pusherprovider","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"PusherProvider\""},{"id":40,"kind":1,"name":"\"mocks\"","url":"modules/_mocks_.html","classes":"tsd-kind-external-module"},{"id":41,"kind":128,"name":"PusherChannelMock","url":"classes/_mocks_.pusherchannelmock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":42,"kind":1024,"name":"callbacks","url":"classes/_mocks_.pusherchannelmock.html#callbacks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":43,"kind":65536,"name":"__type","url":"classes/_mocks_.pusherchannelmock.html#callbacks.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"mocks\".PusherChannelMock.callbacks"},{"id":44,"kind":1024,"name":"name","url":"classes/_mocks_.pusherchannelmock.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":45,"kind":512,"name":"constructor","url":"classes/_mocks_.pusherchannelmock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":46,"kind":2048,"name":"bind","url":"classes/_mocks_.pusherchannelmock.html#bind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":47,"kind":2048,"name":"unbind","url":"classes/_mocks_.pusherchannelmock.html#unbind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":48,"kind":2048,"name":"emit","url":"classes/_mocks_.pusherchannelmock.html#emit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":49,"kind":2048,"name":"trigger","url":"classes/_mocks_.pusherchannelmock.html#trigger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":50,"kind":128,"name":"PusherPresenceChannelMock","url":"classes/_mocks_.pusherpresencechannelmock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":51,"kind":1024,"name":"members","url":"classes/_mocks_.pusherpresencechannelmock.html#members","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":52,"kind":1024,"name":"myID","url":"classes/_mocks_.pusherpresencechannelmock.html#myid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":53,"kind":512,"name":"constructor","url":"classes/_mocks_.pusherpresencechannelmock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":54,"kind":1024,"name":"callbacks","url":"classes/_mocks_.pusherpresencechannelmock.html#callbacks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":55,"kind":65536,"name":"__type","url":"classes/_mocks_.pusherpresencechannelmock.html#callbacks.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"mocks\".PusherPresenceChannelMock.callbacks"},{"id":56,"kind":1024,"name":"name","url":"classes/_mocks_.pusherpresencechannelmock.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":57,"kind":2048,"name":"bind","url":"classes/_mocks_.pusherpresencechannelmock.html#bind","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":58,"kind":2048,"name":"unbind","url":"classes/_mocks_.pusherpresencechannelmock.html#unbind","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":59,"kind":2048,"name":"emit","url":"classes/_mocks_.pusherpresencechannelmock.html#emit","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":60,"kind":2048,"name":"trigger","url":"classes/_mocks_.pusherpresencechannelmock.html#trigger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":61,"kind":128,"name":"PusherMock","url":"classes/_mocks_.pushermock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":62,"kind":1024,"name":"key","url":"classes/_mocks_.pushermock.html#key","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":63,"kind":1024,"name":"config","url":"classes/_mocks_.pushermock.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":64,"kind":1024,"name":"channels","url":"classes/_mocks_.pushermock.html#channels","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":65,"kind":65536,"name":"__type","url":"classes/_mocks_.pushermock.html#channels.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"mocks\".PusherMock.channels"},{"id":66,"kind":512,"name":"constructor","url":"classes/_mocks_.pushermock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":67,"kind":2048,"name":"channel","url":"classes/_mocks_.pushermock.html#channel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":68,"kind":2048,"name":"subscribe","url":"classes/_mocks_.pushermock.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":69,"kind":2048,"name":"unsubscribe","url":"classes/_mocks_.pushermock.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":70,"kind":2048,"name":"disconnect","url":"classes/_mocks_.pushermock.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":71,"kind":1,"name":"\"usePusher\"","url":"modules/_usepusher_.html","classes":"tsd-kind-external-module"},{"id":72,"kind":64,"name":"usePusher","url":"modules/_usepusher_.html#usepusher","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"usePusher\""},{"id":73,"kind":32,"name":"NOT_IN_CONTEXT_WARNING","url":"modules/_usepusher_.html#not_in_context_warning","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"usePusher\""},{"id":74,"kind":1,"name":"\"useChannel\"","url":"modules/_usechannel_.html","classes":"tsd-kind-external-module"},{"id":75,"kind":64,"name":"useChannel","url":"modules/_usechannel_.html#usechannel","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"useChannel\""},{"id":76,"kind":1,"name":"\"useClientTrigger\"","url":"modules/_useclienttrigger_.html","classes":"tsd-kind-external-module"},{"id":77,"kind":64,"name":"useClientTrigger","url":"modules/_useclienttrigger_.html#useclienttrigger","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"useClientTrigger\""},{"id":78,"kind":1,"name":"\"useEvent\"","url":"modules/_useevent_.html","classes":"tsd-kind-external-module"},{"id":79,"kind":64,"name":"useEvent","url":"modules/_useevent_.html#useevent","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"useEvent\""},{"id":80,"kind":1,"name":"\"usePresenceChannel\"","url":"modules/_usepresencechannel_.html","classes":"tsd-kind-external-module"},{"id":81,"kind":64,"name":"usePresenceChannel","url":"modules/_usepresencechannel_.html#usepresencechannel","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"usePresenceChannel\""},{"id":82,"kind":1,"name":"\"useTrigger\"","url":"modules/_usetrigger_.html","classes":"tsd-kind-external-module"},{"id":83,"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 + typedoc.search.data = {"kinds":{"1":"External module","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","4194304":"Type alias"},"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":256,"name":"PusherProviderProps","url":"interfaces/_types_.pusherproviderprops.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"types\""},{"id":5,"kind":1024,"name":"clientKey","url":"interfaces/_types_.pusherproviderprops.html#clientkey","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":6,"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":7,"kind":1024,"name":"triggerEndpoint","url":"interfaces/_types_.pusherproviderprops.html#triggerendpoint","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":8,"kind":1024,"name":"defer","url":"interfaces/_types_.pusherproviderprops.html#defer","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":9,"kind":1024,"name":"value","url":"interfaces/_types_.pusherproviderprops.html#value","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"types\".PusherProviderProps"},{"id":10,"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":11,"kind":1024,"name":"enableStats","url":"interfaces/_types_.pusherproviderprops.html#enablestats","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":12,"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":13,"kind":1024,"name":"authEndpoint","url":"interfaces/_types_.pusherproviderprops.html#authendpoint","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":14,"kind":1024,"name":"auth","url":"interfaces/_types_.pusherproviderprops.html#auth","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":15,"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":16,"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":17,"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":18,"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":19,"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":20,"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":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":"pongTimeout","url":"interfaces/_types_.pusherproviderprops.html#pongtimeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":23,"kind":1024,"name":"statsHost","url":"interfaces/_types_.pusherproviderprops.html#statshost","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":24,"kind":1024,"name":"timelineParams","url":"interfaces/_types_.pusherproviderprops.html#timelineparams","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":25,"kind":1024,"name":"unavailable_timeout","url":"interfaces/_types_.pusherproviderprops.html#unavailable_timeout","classes":"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited","parent":"\"types\".PusherProviderProps"},{"id":26,"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":27,"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":28,"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":29,"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":30,"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":31,"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":32,"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":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 tsd-is-not-exported","parent":"\"PusherProvider\""},{"id":35,"kind":32,"name":"__PusherContext","url":"modules/_pusherprovider_.html#__pushercontext","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":"\"mocks\"","url":"modules/_mocks_.html","classes":"tsd-kind-external-module"},{"id":38,"kind":128,"name":"PusherChannelMock","url":"classes/_mocks_.pusherchannelmock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":39,"kind":1024,"name":"callbacks","url":"classes/_mocks_.pusherchannelmock.html#callbacks","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":40,"kind":65536,"name":"__type","url":"classes/_mocks_.pusherchannelmock.html#callbacks.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"mocks\".PusherChannelMock.callbacks"},{"id":41,"kind":1024,"name":"name","url":"classes/_mocks_.pusherchannelmock.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":42,"kind":512,"name":"constructor","url":"classes/_mocks_.pusherchannelmock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":43,"kind":2048,"name":"bind","url":"classes/_mocks_.pusherchannelmock.html#bind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":44,"kind":2048,"name":"unbind","url":"classes/_mocks_.pusherchannelmock.html#unbind","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":45,"kind":2048,"name":"emit","url":"classes/_mocks_.pusherchannelmock.html#emit","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":46,"kind":2048,"name":"trigger","url":"classes/_mocks_.pusherchannelmock.html#trigger","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherChannelMock"},{"id":47,"kind":128,"name":"PusherPresenceChannelMock","url":"classes/_mocks_.pusherpresencechannelmock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":48,"kind":1024,"name":"members","url":"classes/_mocks_.pusherpresencechannelmock.html#members","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":49,"kind":1024,"name":"myID","url":"classes/_mocks_.pusherpresencechannelmock.html#myid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":50,"kind":512,"name":"constructor","url":"classes/_mocks_.pusherpresencechannelmock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":51,"kind":1024,"name":"callbacks","url":"classes/_mocks_.pusherpresencechannelmock.html#callbacks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":52,"kind":65536,"name":"__type","url":"classes/_mocks_.pusherpresencechannelmock.html#callbacks.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"mocks\".PusherPresenceChannelMock.callbacks"},{"id":53,"kind":1024,"name":"name","url":"classes/_mocks_.pusherpresencechannelmock.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":54,"kind":2048,"name":"bind","url":"classes/_mocks_.pusherpresencechannelmock.html#bind","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":55,"kind":2048,"name":"unbind","url":"classes/_mocks_.pusherpresencechannelmock.html#unbind","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":56,"kind":2048,"name":"emit","url":"classes/_mocks_.pusherpresencechannelmock.html#emit","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":57,"kind":2048,"name":"trigger","url":"classes/_mocks_.pusherpresencechannelmock.html#trigger","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-inherited","parent":"\"mocks\".PusherPresenceChannelMock"},{"id":58,"kind":128,"name":"PusherMock","url":"classes/_mocks_.pushermock.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"mocks\""},{"id":59,"kind":1024,"name":"key","url":"classes/_mocks_.pushermock.html#key","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":60,"kind":1024,"name":"config","url":"classes/_mocks_.pushermock.html#config","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":61,"kind":1024,"name":"channels","url":"classes/_mocks_.pushermock.html#channels","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":62,"kind":65536,"name":"__type","url":"classes/_mocks_.pushermock.html#channels.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property","parent":"\"mocks\".PusherMock.channels"},{"id":63,"kind":512,"name":"constructor","url":"classes/_mocks_.pushermock.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":64,"kind":2048,"name":"channel","url":"classes/_mocks_.pushermock.html#channel","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":65,"kind":2048,"name":"subscribe","url":"classes/_mocks_.pushermock.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":66,"kind":2048,"name":"unsubscribe","url":"classes/_mocks_.pushermock.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":67,"kind":2048,"name":"disconnect","url":"classes/_mocks_.pushermock.html#disconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"mocks\".PusherMock"},{"id":68,"kind":4194304,"name":"CallbackSignature","url":"modules/_mocks_.html#callbacksignature","classes":"tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"mocks\""},{"id":69,"kind":65536,"name":"__type","url":"modules/_mocks_.html#callbacksignature.__type","classes":"tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported","parent":"\"mocks\".CallbackSignature"},{"id":70,"kind":1,"name":"\"usePusher\"","url":"modules/_usepusher_.html","classes":"tsd-kind-external-module"},{"id":71,"kind":64,"name":"usePusher","url":"modules/_usepusher_.html#usepusher","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"usePusher\""},{"id":72,"kind":32,"name":"NOT_IN_CONTEXT_WARNING","url":"modules/_usepusher_.html#not_in_context_warning","classes":"tsd-kind-variable tsd-parent-kind-external-module","parent":"\"usePusher\""},{"id":73,"kind":1,"name":"\"useChannel\"","url":"modules/_usechannel_.html","classes":"tsd-kind-external-module"},{"id":74,"kind":64,"name":"useChannel","url":"modules/_usechannel_.html#usechannel","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"useChannel\""},{"id":75,"kind":1,"name":"\"useClientTrigger\"","url":"modules/_useclienttrigger_.html","classes":"tsd-kind-external-module"},{"id":76,"kind":64,"name":"useClientTrigger","url":"modules/_useclienttrigger_.html#useclienttrigger","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"useClientTrigger\""},{"id":77,"kind":1,"name":"\"useEvent\"","url":"modules/_useevent_.html","classes":"tsd-kind-external-module"},{"id":78,"kind":64,"name":"useEvent","url":"modules/_useevent_.html#useevent","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"useEvent\""},{"id":79,"kind":1,"name":"\"usePresenceChannel\"","url":"modules/_usepresencechannel_.html","classes":"tsd-kind-external-module"},{"id":80,"kind":64,"name":"usePresenceChannel","url":"modules/_usepresencechannel_.html#usepresencechannel","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"usePresenceChannel\""},{"id":81,"kind":1,"name":"\"useTrigger\"","url":"modules/_usetrigger_.html","classes":"tsd-kind-external-module"},{"id":82,"kind":64,"name":"useTrigger","url":"modules/_usetrigger_.html#usetrigger","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"useTrigger\""}]}; \ No newline at end of file diff --git a/docs/classes/_mocks_.pusherchannelmock.html b/docs/classes/_mocks_.pusherchannelmock.html index 0666b18..2ac2261 100644 --- a/docs/classes/_mocks_.pusherchannelmock.html +++ b/docs/classes/_mocks_.pusherchannelmock.html @@ -123,7 +123,7 @@

constructor

  • Parameters

    @@ -145,7 +145,7 @@

    callbacks

    callbacks: {}
    @@ -157,7 +157,7 @@

    callbacks

    Type declaration

    @@ -168,7 +168,7 @@

    name

    name: string
    @@ -179,13 +179,13 @@

    Methods

    bind

    diff --git a/docs/classes/_mocks_.pusherpresencechannelmock.html b/docs/classes/_mocks_.pusherpresencechannelmock.html index 13f6a34..f53e0a9 100644 --- a/docs/classes/_mocks_.pusherpresencechannelmock.html +++ b/docs/classes/_mocks_.pusherpresencechannelmock.html @@ -126,7 +126,7 @@

    constructor

    Parameters

    @@ -149,7 +149,7 @@

    callbacks

    @@ -161,7 +161,7 @@

    callbacks

    Type declaration

    @@ -172,7 +172,7 @@

    members

    members: any
    @@ -182,7 +182,7 @@

    myID

    myID: any
    @@ -193,7 +193,7 @@

    name

    @@ -204,14 +204,14 @@

    Methods

    bind

    diff --git a/docs/interfaces/_types_.pusherproviderprops.html b/docs/interfaces/_types_.pusherproviderprops.html index 2b101ea..9ba6ff3 100644 --- a/docs/interfaces/_types_.pusherproviderprops.html +++ b/docs/interfaces/_types_.pusherproviderprops.html @@ -90,11 +90,10 @@

    Index

    Properties

    -
    +

    Optional auth

    auth: AuthOptions
    -
    +

    Optional authEndpoint

    authEndpoint: undefined | string
    @@ -180,34 +179,24 @@

    Optional authorizer

    -
    - -

    children

    -
    children: React.ReactNode
    - -

    clientKey

    clientKey: string

    cluster

    -
    cluster: string
    +
    cluster: "mt1" | "us2" | "us3" | "eu" | "ap1" | "ap2" | "ap3" | "ap4"
    @@ -217,7 +206,7 @@

    Optional defer

    defer: undefined | false | true
    @@ -370,7 +359,7 @@

    Optional triggerEndpoint<
    triggerEndpoint: undefined | string
    @@ -388,10 +377,10 @@

    Optional unavailable_time

    Optional value

    -
    value: any
    +
    value: PusherContextValues
    @@ -489,10 +478,10 @@

    Optional wssPort

  • activityTimeout
    • -
  • +
  • auth
    • -
  • +
  • authEndpoint
  • @@ -501,9 +490,6 @@

    Optional wssPort

  • authorizer
    • -
  • - children -
  • clientKey
    • @@ -577,9 +563,6 @@

    Optional wssPort

    diff --git a/docs/interfaces/_types_.usechanneloptions.html b/docs/interfaces/_types_.usechanneloptions.html deleted file mode 100644 index 0b7399e..0000000 --- a/docs/interfaces/_types_.usechanneloptions.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - - useChannelOptions | @harelpls/use-pusher - - - - - -
    -
    -
    -
    - -
    -
    - Options -
    -
    - All -
      -
    • Public
      • -
    • Public/Protected
      • -
    • All
      • -
    -
    - - - - - - -
    -
    - Menu -
    -
    -
    -
    -
    -
    - -

    Interface useChannelOptions

    -
    -
    -
    -
    -
    -
    -
    -

    Hierarchy

    -
      -
    • - useChannelOptions -
      • -
    -
    -
    -

    Index

    -
    -
    -
    -

    Properties

    - -
    -
    -
    -
    -
    -

    Properties

    -
    - -

    Optional skip

    -
    skip: undefined | false | true
    - -
    -
    -
    -
    - - -
    -
    -
    - -
    -

    Generated using TypeDoc

    -
    -
    - - - - \ No newline at end of file diff --git a/docs/modules/_mocks_.html b/docs/modules/_mocks_.html index 8fcbc6a..7bbb8b0 100644 --- a/docs/modules/_mocks_.html +++ b/docs/modules/_mocks_.html @@ -78,6 +78,49 @@

    Classes

  • PusherPresenceChannelMock
    • +
    +

    Type aliases

    + +
    + + + +
    +

    Type aliases

    +
    + +

    CallbackSignature

    +
    CallbackSignature: (data: any, metadata?: any) => void
    + +
    +

    Type declaration

    +
      +
    • +
        +
      • (data: any, metadata?: any): void
        • +
      +
        +
      • +

        Parameters

        +
          +
        • +
          data: any
          +
          • +
        • +
          Optional metadata: any
          +
          • +
        +

        Returns void

        +
        • +
      +
      • +
    @@ -128,6 +171,9 @@

    Classes

  • PusherPresenceChannelMock
    • +
  • + CallbackSignature +
    • diff --git a/docs/modules/_pusherprovider_.html b/docs/modules/_pusherprovider_.html index 192057b..728727d 100644 --- a/docs/modules/_pusherprovider_.html +++ b/docs/modules/_pusherprovider_.html @@ -94,7 +94,7 @@

    Const PusherContext

    PusherContext: Context<PusherContextValues> = React.createContext<PusherContextValues>({})
    @@ -104,7 +104,7 @@

    Const __PusherContext__PusherContext: Context<PusherContextValues> = PusherContext @@ -113,47 +113,43 @@

    Const __PusherContextFunctions

    -

    PusherProvider

    +

    Const PusherProvider

    @@ -125,9 +124,6 @@

    Interfaces

  • PusherProviderProps
    • -
  • - useChannelOptions -
    • diff --git a/docs/modules/_usechannel_.html b/docs/modules/_usechannel_.html index 69d4aa2..ad4024e 100644 --- a/docs/modules/_usechannel_.html +++ b/docs/modules/_usechannel_.html @@ -73,7 +73,7 @@

    Index

    Functions

    @@ -81,36 +81,50 @@

    Functions

    Functions

    -
    +

    useChannel

    -
      -
    • useChannel(channelName: string): any
      • +
        +
      • useChannel<T>(channelName: string): undefined | T
      • -

        Subscribe to channel

        +

        Subscribe to a channel

        +
        typeparam
        +

        of channel you're subscribing to. Can be one of Channel or PresenceChannel from pusher-js.

        +
        example
        -

        useChannel("my-channel")

        + 
        const channel = useChannel("my-channel")
+channel.bind('some-event', () => {})
        +

        Type parameters

        +
          +
        • +

          T: Channel & PresenceChannel

          +
          • +

        Parameters

        • channelName: string
          +
          +

          The name of the channel you want to subscribe to.

          +
        -

        Returns any

        +

        Returns undefined | T

        +

        Instance of the channel you just subscribed to.

    @@ -153,7 +167,7 @@

    Returns any

    Functions

    -
    +

    useClientTrigger

    -
      -
    • useClientTrigger(channel: Channel | PresenceChannel): (Anonymous function)
      • +
        +
      • useClientTrigger<TData>(channel: Channel | PresenceChannel): (Anonymous function)
      • +
        +
        +
        example
        + 
        const channel = useChannel('my-channel');
+const trigger = useClientTrigger(channel)
+
+const handleClick = () => trigger('some-client-event', {});
        +
        +
        +
        +

        Type parameters

        +
          +
        • +

          TData

          +
          +

          shape of the data you're sending with the event.

          +
          +
          • +

        Parameters

        • channel: Channel | PresenceChannel
          +
          +

          the channel you'd like to trigger clientEvents on. Get this from useChannel or usePresenceChannel.

          +

        Returns (Anonymous function)

        +

        A memoized trigger function that will perform client events on the channel.

    @@ -143,7 +166,7 @@

    Returns (Anonymou

    @@ -110,21 +110,22 @@

    usePusher

  • -

    Provides access to the pusher client

    +

    Provides access to the pusher client instance.

    example
    -

    const {client} = usePusher(); - client.current.subscribe('my-channel');

    + 
    const { client } = usePusher();
+client.current.subscribe('my-channel');

    Returns PusherContextValues

    +

    a MutableRefObject<Pusher|undefined>. The instance is held by a useRef() hook.

    • diff --git a/docs/modules/_usetrigger_.html b/docs/modules/_usetrigger_.html index 36d6e0b..acf145c 100644 --- a/docs/modules/_usetrigger_.html +++ b/docs/modules/_usetrigger_.html @@ -73,7 +73,7 @@

    Index

    Functions

    @@ -81,34 +81,47 @@

    Functions

    Functions

    -
    +

    useTrigger

    -
      -
    • useTrigger(channelName: string): (Anonymous function)
      • +
        +
      • useTrigger<TData>(channelName: string): (Anonymous function)
      • -

        Trigger events hook

        +

        Hook to provide a trigger function that calls the server defined in PusherProviderProps.triggerEndpoint using fetch. + Any auth?.headers in the config object will be passed with the fetch call.

        example
        -

        const trigger = useTrigger('my-channel'); - trigger('my-event', {message: 'hello'});

        + 
        const trigger = useTrigger<{message: string}>('my-channel');
+trigger('my-event', {message: 'hello'});
        +

        Type parameters

        +
          +
        • +

          TData

          +
          +

          shape of the data you're sending with the event

          +
          +
          • +

        Parameters

        • channelName: string
          +
          +

          name of channel to call trigger on

          +

        Returns (Anonymous function)

        @@ -154,7 +167,7 @@

        Returns (Anonymou