npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@eflyn/sdk

v6.24.1

Published

General namespaces for functions provided via global window.eflyn API to control platform and player applications.

Downloads

35

Readme

Eflyn SDK

Welcome to the Eflyn SDK, a comprehensive JavaScript-based Software Development Kit that allows developers to access a variety of Kiosk APIs while developing applications on the Eflyn Kiosk Platform.

Introduction

The Eflyn Kiosk Developer Platform is a powerful ecosystem that offers developers a suite of APIs, tools, and pre-built workflows to expedite the creation, testing, and deployment of kiosk applications. Our platform is dedicated to delivering an unmatched user experience, ensuring that your kiosk applications stand out in the market.

Key Features

  • Speedy App Development: Leverage our robust API suite for efficient and effortless custom kiosk app creation.
  • Admin API: Seamlessly manage kiosk hardware and applications with our fully-typed, open-source API.
  • Custom Kiosk Apps: Utilize the E Suite Platform SDK for seamless integrations with Kiosk OS, barcode scanners, printers, and more.
  • Payment Acceptance: Integrate in-person payments directly on the kiosk using our Payment API, compatible with popular North American payment platforms.
  • Developer Onboarding: Benefit from comprehensive support, detailed documentation, and consultation services for a smooth onboarding experience.

Getting Started

The SDK object is provided by calling the connectClient() method exported from the @eflyn/sdk package.


import { connectClient } from '@eflyn/sdk';

const eflyn = connectClient();
eflyn.printer.printHtml({
  html: `TEST RECEIPT $10.00`
});

Another option is using the hosted sdk.js script in your HTML:

<!DOCTYPE html>
<html>
    <head>
        <title>Example Kiosk App</title>
    </head>
    <body>
        <!-- Import sdj.js to access Eflyn SDK -->
        <script src="/sdk.js"></script>
        <!-- Start custom script that uses the eflyn SDK -->
        <script>
            const eflyn = connectClient();
            eflyn.printer.printHtml({
                html: `TEST RECEIPT $10.00`
            });
        </script>
    </body>
</html>

Examples

Find example scripts below that demonstrate how to utilize the Eflyn SDK to build applications on the Kiosk Platform.

Kiosk Printing

Print 80mm wide receipts using the Printer API:

eflyn.printer.printHtml({
  html: `
    <h3>Print Test</h3>
    <p>Print real HTML here!</p>
  `
});

Take Payments

Accept payments on the pinpad using the paymentService API:

eflyn.payment.approve({
  amount: 5.00,
  invoice: 'invid'
});

Read Barcodes

Listen for scan events with the barcode service:

eflyn.on('eflyn.barcode.read', ({ code }) =>
  alert('Scanned: ' + code)
);

Sample App 🚀

Check out the kiosk example app here that will give you a more comprehensive understanding of how web apps are setup and integrated with the Eflyn SDK. You can also copy the link and set it up as a Custom App in your backend to get started.