Class LocationsModule

Returns LocationsModule

Returns Promise<Location>

A promise that resolves to the created location.

const newLocation = await ptero.locations.createLocation({
  short: "ap-south",
  long: "Asia Pacific South"
});
console.log(newLocation);
Copy

Returns Promise<boolean>

A promise that resolves to true if the location was successfully deleted.

const deleted = await ptero.locations.deleteLocation({ id: 3 });
console.log(deleted); // true
Copy

Returns Promise<LocationAttributes[]>

A promise that resolves to an array of location attributes.

const locations = await ptero.locations.fetchAll();
console.log(locations);
Copy

Returns Promise<LocationAttributes>

A promise that resolves to the location attributes.

const location = await ptero.locations.fetchOne({ id: 1 });
console.log(location);
Copy

Returns Promise<LocationAttributes>

A promise that resolves to the updated location attributes.

const updatedLocation = await ptero.locations.updateLocation({
  id: 3,
  short: "apac-south",
  long: "Asia Pacific South Region"
});
console.log(updatedLocation);
Copy