Introducing React 18 support

What's Changed

• Bump lodash from 4.17.15 to 4.17.19 by @dependabot in #8
• Bump lodash from 4.17.15 to 4.17.19 in /example by @dependabot in #9
• Security fixes; Example update by @kmoskwiak in #10
• Bump elliptic from 6.5.2 to 6.5.3 in /example by @dependabot in #11
• Fix typo in message by @leonardoalifraco in #23

New Contributors

• @dependabot made their first contribution in #8
• @leonardoalifraco made their first contribution in #23

Full Changelog: v2.0.0...v3.0.0-beta.0

• [fixed] fixed examples
• [security] updated dependencies

Initial state is no longer passed to hook. It will be always set to null.

// before
const [data, error] = useSSE(
  { data: 'initial data' }
  () => {
    return fetch();
  },
  []
);

// after
const [data, error] = useSSE(() => {
  return fetch();
}, []);

Errors are returned separately from data.

// before
const [data] = useSSE();
// if error happend data.isError was true

// now
const [data, error] = useSSE();
// error has all error details

Readme update

Added possibility to specify timeout value on server-side.

const data = await resolveData(timeout);

This version comes with breaking changes. Versions 0.x.x are not compatible.

• key param is no longer needed,
• name of global variable is now customizable,
• seperation of data an internal contexts.

Migration from 0.x.x consists in removing key param from the useSSE hook calls:

// before
const [data] = useSSE(
  {},
  "my_key",
  () => {
    return fetch();
  },
  []
);

// after
const [data] = useSSE(
  {},
  () => {
    return fetch();
  },
  []
);