Skip to content

Commit

Permalink
Added license, updated README.md, added author
Browse files Browse the repository at this point in the history
  • Loading branch information
Slaven Ivanov authored and Slaven Ivanov committed Aug 12, 2022
1 parent 9804714 commit 13e704a
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 9 deletions.
15 changes: 15 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
ISC License

Copyright (c) 2022 Growy

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# AWS Lambda Utility Package

AWS Lambda validations made easy 🏄‍♀
AWS Lambda validations made easy 🏄‍♀ ️and some other things

```typescript
class BodyType {
@IsEmail
email: string
}

class SpamBot {
@Handler()
static async handle(@Body() { email }: BodyType) {
sendSpam(email) // -> Hi👋 ️👆 I'm validated
await sendSpam(email) // -> ️👆 I'm validated
return ok()
}
}

class BodyType {
@IsEmail
email: string
}
export const handler = SpamBot.handle
```

## Table of Contents
Expand All @@ -31,7 +34,7 @@ class BodyType {
First off we need to install the package

```shell
TODO!!! 🤯
npm i aws-lambda-handyman
```

Since we use ```class-validator``` under the hood we need to install it for its validation decorators
Expand Down Expand Up @@ -242,3 +245,5 @@ class IsBalloonInflated {
- [ ] possibly cull undefined properties in validated objects
- [ ] rollup build to minify package
- [ ] non promise response functions
- [ ] add Growy logo
- [ ] setup branch protection
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
{
"name": "aws-lambda-handyman",
"version": "0.0.1",
"version": "0.0.3",
"description": "",
"main": "lib/index.js",
"scripts": {
"build": "tsc",
"test": "jest",
"prettier": "npx prettier --write ."
},
"author": "",
"author": "Slaven Ivanov <[email protected]>",
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/growx-tech/aws-lambda-handyman.git"
},
"devDependencies": {
"@types/aws-lambda": "^8.10.101",
"@types/jest": "^28.1.6",
Expand Down

0 comments on commit 13e704a

Please sign in to comment.