# sesame-api

> A package for use Sesame API in NodeJS

Latest version **2.0.0** (published 2023-12-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install sesame-api
pnpm add sesame-api
yarn add sesame-api
bun add sesame-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-12-28 |
| First published | 2023-12-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 18.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Naflouille-Creations |
| Maintainers | rithyn |
| Keywords | api, starblast, Sesame, Sesame Database, Naf, Naflouille, Naflouille-Creations |

## Links

- npm: https://www.npmjs.com/package/sesame-api
- Repository: https://github.com/Naflouille-Creations/sesame-api-package
- Homepage: https://naflouille-creations.com/
- Issues: https://github.com/Naflouille-Creations/sesame-api-package/issues
- npm.io page: https://npm.io/package/sesame-api

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2023-12-28
- 1.3.3 — 2023-12-25
- 1.3.2 — 2023-12-25
- 1.3.1 — 2023-12-25
- 1.2.7 — 2023-12-24
- 1.2.6 — 2023-12-24
- 1.2.5 — 2023-12-24
- 1.2.4 — 2023-12-24
- 1.2.0 — 2023-12-24
- 1.1.5 — 2023-12-24
- 1.1.4 — 2023-12-24
- 1.1.3 — 2023-12-23
- 0.1.5 — 2023-12-23
- 0.1.4 — 2023-12-23
- 0.1.3 — 2023-12-23
- … 2 more at https://npm.io/package/sesame-api/versions

## README

# Sesame API Package

This package was created by Naflouille Creations.

## Instructions for use

*Documentation will be available on SesAPI shortly.
### Installing the package
To install this package, you first need to have NodeJS and NPM installed.
Then you can install the package.
```
npm install sesame-api
```
To use the Sesame API, you must first define sesame in your NodeJS script
```javascript
const sesame = require("sesame-api");
```
Once this is done, you can use the API functions to search the Sesame database.


## Usage/Examples

```javascript
const sesame = require("sesame-api");
let data = sesame.search.SearchInDatabase("Rithy", "users");
console.log(data);
```
The `data` variable normally contains :
```js
[
  {
    name: 'Rithy',
    description: 'A guy.',
    links: [...],
    about: {
      isStaff: false,
      isModder: false,
      isUCP: false,
      isContrib: false,
      isSesame: true
    },
    sesameID: 'usr-RTY-bDEO1zR7Gx',
    templateImage: 'https://github.com/rithyn/rithy-archive/blob/main/pictures/ucp/rithy.png?raw=true'
  }
]
```
The search function is normally `sesame.search.SearchInDatabase(KEYWORDS, TYPE);`

`TYPE` can be `"users"`, `"ships"`, `"mods"`, `"codes"` and `"communities"`. 

`KEYWORDS` is your keyword.

## 
# Links
[![Sesame](https://img.shields.io/badge/Sesame-red.svg?logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iNTEyLjAwMDAwMHB0IiBoZWlnaHQ9IjUxMi4wMDAwMDBwdCIgdmlld0JveD0iMCAwIDUxMi4wMDAwMDAgNTEyLjAwMDAwMCIKIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIG1lZXQiPgoKPGcgdHJhbnNmb3JtPSJ0cmFuc2xhdGUoMC4wMDAwMDAsNTEyLjAwMDAwMCkgc2NhbGUoMC4xMDAwMDAsLTAuMTAwMDAwKSIKZmlsbD0iIzAwMDAwMCIgc3Ryb2tlPSJub25lIj4KPHBhdGggZD0iTTIxNzUgNDY1NSBjLTE4IC0xNyAtMjUgLTM1IC0yNSAtNjAgMCAtMjIgOTYgLTMxNSAyMzYgLTcxOCAxMzAKLTM3NSAzODQgLTExMTggNTY0IC0xNjUyIDQyMyAtMTI1MyA1NjIgLTE2NDEgNjAxIC0xNjc3IGwyOSAtMjggNDcxIDAgNDcxIDAKMjkgMjkgYzIwIDIwIDI5IDM5IDI5IDYxIDAgMTcgLTcyIDIyMyAtMTU5IDQ1OCAtMTQyMCAzODA4IC0xMzI3IDM1NjIgLTEzNTMKMzU4OSBsLTIxIDIzIC00MjQgMCAtNDI0IDAgLTI0IC0yNXoiLz4KPHBhdGggZD0iTTE2MzAgMzM3NyBjLTIyIC0xMSAtNTcgLTk5IC0yNjEgLTY0MiAtNjYyIC0xNzY5IC03NzkgLTIwOTEgLTc3OQotMjEyOCAwIC0yOCA3IC00NCAyNiAtNjIgbDI3IC0yNSA0NjMgMCA0NjMgMCAyNSAyMyBjMzAgMjYgMTcxIDQxNCA0MTUgMTE0OQpsMTUzIDQ1OCAtMTk0IDU5MiBjLTIwOSA2NDMgLTIxMSA2NDggLTI4MCA2NDggLTE4IDAgLTQ0IC02IC01OCAtMTN6Ii8+CjwvZz4KPC9zdmc+Cg==)](https://naflouille-creations.com/sesame)

[![Sesame API Package](https://img.shields.io/npm/v/sesame-api.svg?logo=npm)](https://npmjs.com/sesame-api)



# Authors

[@naflouille](https://github.com/w0lfan)

[@rithy](https://github.com/rithyn)

---
_Source: https://npm.io/package/sesame-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._