freeonesapi
v0.1.0
Published
The unofficial FreeOnes Node.js API
Downloads
2
Readme
An unofficial Freeones.la Node.js Api
Table of Content
Usage
import freeonesApi from 'freeonesapi'
Api
getBabe
Gets Information from a Single Babe
Option | Type | Default Value | Description | :---:|:---:|:---:|:---:| | name | String | - | Name of the Porn Star | | options | BabeOptions | see Example | Options too alter the output |
freeonesApi.getBabe(
'Ava Addams',
{
InfoOptions: {
request: true
},
PhotoOptions: {
request: true,
importAmmount: 12,
},
LinkOptions: {
request: true,
importAmmount: 12,
}
}
).then(res => {
...
})
Returns Babe
getBabes
Gets Information from the Babes page
Parameter
filter
Filterschema see on Gitlab
options
Optionsschema see on Gitlab
reRequest
: Booleansets if the function is allowed too make more then one requestreturnLength
: NumberifreRequest
is true the Function is requesting new Pages as long as the return Array has a length greater or equal to this value.customFilter
: async FunctionThecustomFIlter
-Function is used on every babe and is passedBabeSimple
Element and must respond with aPromise<boolean>
type. If the Fuction returns true it will save the current Babe if False it will kick the item out of the response.
Example
Option | Type | Default Value | Description | :---:|:---:|:---:|:---:| | filter | BabeFilter | see Example | Object that contains Filter too alter the Return | | options | GetBabesOptions | see Example | Object that contains Options for the Request |
freeonesApi.getBabes({
display: 12,
sortBy: sortByFilter.lat,
keyword: '',
ordering: orderingFilter.asc
}, {
reRequest: false,
returnLength: 12,
customFilter: async () => true
}).then(res => {
...
})
Returns BabeSimple[]
getAlbum
Gets Photos from the Album page
Option | Type | Default Value | Description | :---:|:---:|:---:|:---:| | link | String | - | Link to the Album |
freeonesApi.getAlbum('ava-addams/photos/ava-addams-loves-to-get-nude-and-show-big-melons').then(res => {
...
})
Option | Type | Default Value | Description | :---:|:---:|:---:|:---:| | babeName | String | - | Name of the Babe | | albumName | String | - | Name of the Album |
freeonesApi.getAlbum('Ava Addams', 'Ava Addams loves to get nude and show big Melons').then(res => {
...
})
Returns Album[]