Skip to content

Commit

Permalink
Initial code
Browse files Browse the repository at this point in the history
  • Loading branch information
thevops committed Jun 20, 2024
0 parents commit 04d4dcf
Show file tree
Hide file tree
Showing 8 changed files with 1,775 additions and 0 deletions.
144 changes: 144 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Created by https://www.toptal.com/developers/gitignore/api/node
# Edit at https://www.toptal.com/developers/gitignore?templates=node

### Node ###
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Node Patch ###
# Serverless Webpack directories
.webpack/

# Optional stylelint cache

# SvelteKit build / generate output
.svelte-kit

# End of https://www.toptal.com/developers/gitignore/api/node
12 changes: 12 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
repos:
- repo: local
hooks:
- id: format
name: "Format code with prettier"
entry: /usr/bin/env bash -c "npm run format"
language: script
- id: documentation
name: "Generate documentation"
entry: /usr/bin/env bash -c "npm run docs"
language: script
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Raindrop API

Raindrop API docs: https://developer.raindrop.io/

## Usage

[Example code](./src/example/example.ts)

<!-- TSDOC_START -->

## :factory: Raindrop

### Methods

- [addItem_link](#gear-additem_link)
- [removeItem](#gear-removeitem)
- [getFirstItemFromCollection](#gear-getfirstitemfromcollection)

#### :gear: addItem_link

Add a new link to a collection.

| Method | Type |
| ---------- | ---------- |
| `addItem_link` | `(collectionId: string, link: string) => Promise<boolean>` |

Parameters:

* `collectionId`: - The id of the collection.
* `link`: - The link to add.


#### :gear: removeItem

Remove a single raindrop (item).

| Method | Type |
| ---------- | ---------- |
| `removeItem` | `(itemId: string) => Promise<boolean>` |

Parameters:

* `itemId`: - The id of the raindrop to remove.


#### :gear: getFirstItemFromCollection

Get the first item from a collection.

| Method | Type |
| ---------- | ---------- |
| `getFirstItemFromCollection` | `(collectionId: string) => Promise<{ object: RaindropItem; msg: string; status: boolean; }>` |

Parameters:

* `collectionId`: - The id of the collection.



<!-- TSDOC_END -->
Loading

0 comments on commit 04d4dcf

Please sign in to comment.