Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aacassandra/aac-parsetypescript

This package makes it easy for typescript users for access the parse database via httpclient
https://github.com/aacassandra/aac-parsetypescript

Last synced: about 1 month ago
JSON representation

This package makes it easy for typescript users for access the parse database via httpclient

Awesome Lists containing this project

README

        

aac-parsetypescript version



# Introduction
This package makes it to easy for typescript users for access the parse database via http

## Browser Support

![Chrome](https://raw.github.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/src/safari/safari_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ![Edge](https://raw.github.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ![IE](https://raw.github.com/alrra/browser-logos/master/src/archive/internet-explorer_9-11/internet-explorer_9-11_48x48.png) |
--- | --- | --- | --- | --- | --- |
Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ | 11 ✔ |

[![Browser Matrix](https://saucelabs.com/open_sauce/build_matrix/axios.svg)](https://saucelabs.com/u/axios)

## Installing
```npm install aac-parsetypescript```

## Implement
add this code in app.module.ts:
```
import { ParseTypescript } from "aac-parsetypescript";
```
add to providers
```
providers: [
...,
ParseTypescript,
],
```
add to components or services
```
import { ParseTypescript } from "aac-parsetypescript";
```
add to constructor
```
constructor(
...,
private parseTypescript:parseTypescript
){}
```

## Instance Methods
- getSignin
- getSignup
- getUsers
- getCreate
- getReading
- getUpdate
- getDelete

## Example
Performing a signin request
```
async getSignin(){
let config = {
bashurl: "https://parseapi.example.com",
data: {
username: "songoku",
password: "admin"
},
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getSignin(config)
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
}
```

Performing a signup request
```
async getSignup(){
let config = {
bashurl: "https://parseapi.example.com",
data: {
username: "songoku",
email:"[email protected]",
password: "admin"
},
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getSignup(config)
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
}
```

Perfoming a create request
```
async getCreate(){
let config = {
bashurl: "https://parseapi.example.com",
data: {
//somes data
},
class: "CHANGE-WITH-YOUR-CLASS-TARGET",
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getCreate(config)
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
}
```

Perfoming a reading request

[Readmore](https://docs.parseplatform.org/rest/guide/) about conditional on parse
```
async getReading(){
let config = {
bashurl: "https://parseapi.example.com",
where: '"idExample"="1","nameExample"="Jhon Taruban"',
class: "CHANGE-WITH-YOUR-CLASS-TARGET",
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getReading(config)
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
}
```

Perfoming a update request
```
async getUpdate(){
let config = {
bashurl: "https://parseapi.example.com",
class: "CHANGE-WITH-YOUR-CLASS-TARGET",
id: "CHANGE-WITH-YOUR-OBJECTID-TARGET",
data: {
//somes data
},
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getUpdate(config)
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
}
```

Perfoming a delete request
```
async getDelete(){
let config = {
bashurl: "https://parseapi.example.com",
class: "CHANGE-WITH-YOUR-CLASS-TARGET",
id: "CHANGE-WITH-YOUR-OBJECTID-TARGET",
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getDelete(config)
.then(function (response) {
// handle success
console.log(response);
})
.catch(function (error) {
// handle error
console.log(error);
})
}
```

## NOTES
If you want use (this.) function on (.then) or (.catch)
```
constructor(
private example:Example
){}

async getDelete(){
let self = this;
let config = {
bashurl: "https://parseapi.example.com",
class: "CHANGE-WITH-YOUR-CLASS-TARGET",
id: "CHANGE-WITH-YOUR-OBJECTID-TARGET",
appId: "CHANGE-WITH-YOUR-APP-ID",
restApiKey: "CHANGE-WITH-YOUR-REST-API-KEY"
};
await this.parseTypescript.getDelete(config)
.then(function (response) {
// handle success
console.log(response);
self.example;
})
.catch(function (error) {
// handle error
console.log(error);
self.example;
})
}
```
## CREDITS
aac-parsetypescript is based on [axios](https://github.com/axios/axios) source code and is combined with rules that must be met to access the parse model database. With the final results, it aims as a tool to accelerate the coding process of programmers.

## LICENSE
[MIT](https://github.com/aacassandra/aac-parsetypescript/blob/master/LICENSE)