Giter VIP home page Giter VIP logo

bare-client's Introduction

Bare Client

This package implements the TompHTTP Bare Server as a client.

See the V2 API documentation.

See the changelog.

Upgrading

A guide for updating from v1 to v2 can be found here.

Older Bare servers

Starting from v2, @tomphttp/bare-client only supports Bare servers v3+.

If you operate an outdated Bare server, we encourage you to update. If you're using an outdated Bare server, we encourage you to find an updated Bare server or host your own.

If you're too lazy to do either of the above, you can install an outdated and unsupported version of the Bare client.

npm install @tomphttp/bare-client@1

Quickstart

Script tag:

<script src="https://unpkg.com/@tomphttp/bare-client@placeholder/dist/bare.cjs"></script>
<script>
	console.log(bare); // { createBareClient: ..., BareClient: ... }

	bare.createBareClient('http://localhost:8080/bare/').then(async (client) => {
		const res = await client.fetch('https://api.github.com/orgs/tomphttp', {
			headers: {
				'user-agent': navigator.userAgent, // user-agent must be passed otherwise the API gives a 403
			},
		});

		console.log(await res.json()); // {login: 'tomphttp', id: 98234273, ... }
	});
</script>

ESM/bundler:

npm i @tomphttp/bare-client
import { createBareClient } from '@tomphttp/bare-client';

createBareClient('http://localhost:8080/bare/'); // ...

See examples/.

Notice

client.fetch isn't 1:1 to JavaScript's fetch. It doesn't accept a Request as an argument due to the headers on the Request being "managed":

const a = new Headers(); // unmanaged `Headers`
a.set('user-agent', 'test');
a.get('user-agent'); // "test"

const b = new Request(location.toString()).headers; // managed `Headers`
b.set('user-agent', 'test');
b.get('user-agent'); // null

bare-client's People

Contributors

caracal-js avatar cohenerickson avatar e9x avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.