@nozbe/periscope-client
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

@nozbe/periscope-client

A public (not open-source though) protocol allowing for transferring files across windows and frames.

Terminology

  • inlet - the part that takes the file and sends it to the other end of the periscope where it should be displayed. Usually, this is going be your main content, eg. a React/Vue/Angular app etc., that needs to stay safe.

  • outlet - the part that receives the file from the inlet so it can be processed and displayed in isolation. Usually, this is going be an iframe rendered inside of your app.

  • peeking - the action of sending a file or some other content from the inlet to have it displayed in the outlet.

Known limitations

  • You can't have more than one periscope per inlet window at once.
  • Doesn't support light/dark mode features
  • ???

Readme

Keywords

none

Package Sidebar

Install

npm i @nozbe/periscope-client

Weekly Downloads

1

Version

1.1.0

License

MIT

Unpacked Size

8.57 kB

Total Files

5

Last publish

Collaborators

  • michalpopek
  • nozbe-user
  • tkapelak
  • kokusgr
  • rozpierog
  • jsamelak