diff --git a/.editorconfig b/.editorconfig index e98f58d..ea8f4ab 100644 --- a/.editorconfig +++ b/.editorconfig @@ -1,18 +1,17 @@ -# EditorConfig: http://EditorConfig.org +# EditorConfig is awesome: https://EditorConfig.org -# top-most EditorConfig file root = true -# Unix-style newlines with a newline ending every file [*] -charset = utf-8 end_of_line = lf -trim_trailing_whitespace = true insert_final_newline = true + +[*.{js,d.ts,ts}] +charset = utf-8 +trim_trailing_whitespace = true indent_style = space indent_size = 4 -# 2 space indentation -[*.yaml, *.yml] +[package.json,*.yaml] indent_style = space indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..94f480d --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 7160cdb..9f5d605 100755 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ + +# [2.1.0](https://github.com/faker-javascript/animal) (2022-01-11) +* Added xo, tsd, c8. +* Improved tests. + # [2.0.1](https://github.com/faker-javascript/animal) (2022-01-10) * GitHub docs updates. diff --git a/index.d.ts b/index.d.ts new file mode 100644 index 0000000..a5b298b --- /dev/null +++ b/index.d.ts @@ -0,0 +1,5 @@ +interface Options { + type?: string; + locale?: string; +} +export default function animal(options?: Options): string; diff --git a/index.js b/index.js index ae1830d..409a2de 100644 --- a/index.js +++ b/index.js @@ -1,17 +1,18 @@ +/* eslint camelcase: ["error", {properties: "never"}] */ export default function animal(options) { options = options || {}; - let animals = { - "en_US": { - "ocean" : ["Acantharea","Anemone","Angelfish King","Ahi Tuna","Albacore","American Oyster","Anchovy","Armored Snail","Arctic Char","Atlantic Bluefin Tuna","Atlantic Cod","Atlantic Goliath Grouper","Atlantic Trumpetfish","Atlantic Wolffish","Baleen Whale","Banded Butterflyfish","Banded Coral Shrimp","Banded Sea Krait","Barnacle","Barndoor Skate","Barracuda","Basking Shark","Bass","Beluga Whale","Bluebanded Goby","Bluehead Wrasse","Bluefish","Bluestreak Cleaner-Wrasse","Blue Marlin","Blue Shark","Blue Spiny Lobster","Blue Tang","Blue Whale","Broadclub Cuttlefish","Bull Shark","Chambered Nautilus","Chilean Basket Star","Chilean Jack Mackerel","Chinook Salmon","Christmas Tree Worm","Clam","Clown Anemonefish","Clown Triggerfish","Cod","Coelacanth","Cockscomb Cup Coral","Common Fangtooth","Conch","Cookiecutter Shark","Copepod","Coral","Corydoras","Cownose Ray","Crab","Crown-of-Thorns Starfish","Cushion Star","Cuttlefish","California Sea Otters","Dolphin","Dolphinfish","Dory","Devil Fish","Dugong","Dumbo Octopus","Dungeness Crab","Eccentric Sand Dollar","Edible Sea Cucumber","Eel","Elephant Seal","Elkhorn Coral","Emperor Shrimp","Estuarine Crocodile","Fathead Sculpin","Fiddler Crab","Fin Whale","Flameback","Flamingo Tongue Snail","Flashlight Fish","Flatback Turtle","Flatfish","Flying Fish","Flounder","Fluke","French Angelfish","Frilled Shark","Fugu (also called Pufferfish)","Gar","Geoduck","Giant Barrel Sponge","Giant Caribbean Sea Anemone","Giant Clam","Giant Isopod","Giant Kingfish","Giant Oarfish","Giant Pacific Octopus","Giant Pyrosome","Giant Sea Star","Giant Squid","Glowing Sucker Octopus","Giant Tube Worm","Goblin Shark","Goosefish","Great White Shark","Greenland Shark","Grey Atlantic Seal","Grouper","Grunion","Guineafowl Puffer","Haddock","Hake","Halibut","Hammerhead Shark","Hapuka","Harbor Porpoise","Harbor Seal","Hatchetfish","Hawaiian Monk Seal","Hawksbill Turtle","Hector's Dolphin","Hermit Crab","Herring","Hoki","Horn Shark","Horseshoe Crab","Humpback Anglerfish","Humpback Whale","Icefish","Imperator Angelfish","Irukandji Jellyfish","Isopod","Ivory Bush Coral","Japanese Spider Crab","Jellyfish","John Dory","Juan Fernandez Fur Seal","Killer Whale","Kiwa Hirsuta","Krill","Lagoon Triggerfish","Lamprey","Leafy Seadragon","Leopard Seal","Limpet","Ling","Lionfish","Lions Mane Jellyfish","Lobe Coral","Lobster","Loggerhead Turtle","Longnose Sawshark","Longsnout Seahorse","Lophelia Coral","Marrus Orthocanna","Manatee","Manta Ray","Marlin","Megamouth Shark","Mexican Lookdown","Mimic Octopus","Moon Jelly","Mollusk","Monkfish","Moray Eel","Mullet","Mussel","Megaladon","Napoleon Wrasse","Nassau Grouper","Narwhal","Nautilus","Needlefish","Northern Seahorse","North Atlantic Right Whale","Northern Red Snapper","Norway Lobster","Nudibranch","Nurse Shark","Oarfish","Ocean Sunfish","Oceanic Whitetip Shark","Octopus","Olive Sea Snake","Orange Roughy","Ostracod","Otter","Oyster","Pacific Angelshark","Pacific Blackdragon","Pacific Halibut","Pacific Sardine","Pacific Sea Nettle Jellyfish","Pacific White Sided Dolphin","Pantropical Spotted Dolphin","Patagonian Toothfish","Peacock Mantis Shrimp","Pelagic Thresher Shark","Penguin","Peruvian Anchoveta","Pilchard","Pink Salmon","Pinniped","Plankton","Porpoise","Polar Bear","Portuguese Man o' War","Pycnogonid Sea Spider","Quahog","Queen Angelfish","Queen Conch","Queen Parrotfish","Queensland Grouper","Ragfish","Ratfish","Rattail Fish","Ray","Red Drum","Red King Crab","Ringed Seal","Risso's Dolphin","Ross Seals","Sablefish","Salmon","Sand Dollar","Sandbar Shark","Sawfish","Sarcastic Fringehead","Scalloped Hammerhead Shark","Seahorse","Sea Cucumber","Sea Lion","Sea Urchin","Seal","Shark","Shortfin Mako Shark","Shovelnose Guitarfish","Shrimp","Silverside Fish","Skipjack Tuna","Slender Snipe Eel","Smalltooth Sawfish","Smelts","Sockeye Salmon","Southern Stingray","Sponge","Spotted Porcupinefish","Spotted Dolphin","Spotted Eagle Ray","Spotted Moray","Squid","Squidworm","Starfish","Stickleback","Stonefish","Stoplight Loosejaw","Sturgeon","Swordfish","Tan Bristlemouth","Tasseled Wobbegong","Terrible Claw Lobster","Threespot Damselfish","Tiger Prawn","Tiger Shark","Tilefish","Toadfish","Tropical Two-Wing Flyfish","Tuna","Umbrella Squid","Velvet Crab","Venus Flytrap Sea Anemone","Vigtorniella Worm","Viperfish","Vampire Squid","Vaquita","Wahoo","Walrus","West Indian Manatee","Whale","Whale Shark","Whiptail Gulper","White-Beaked Dolphin","White-Ring Garden Eel","White Shrimp","Wobbegong","Wrasse","Wreckfish","Xiphosura","Yellowtail Damselfish","Yelloweye Rockfish","Yellow Cup Black Coral","Yellow Tube Sponge","Yellowfin Tuna","Zebrashark","Zooplankton"], - "desert" : ["Aardwolf","Addax","African Wild Ass","Ant","Antelope","Armadillo","Baboon","Badger","Bat","Bearded Dragon","Beetle","Bird","Black-footed Cat","Boa","Brown Bear","Bustard","Butterfly","Camel","Caracal","Caracara","Caterpillar","Centipede","Cheetah","Chipmunk","Chuckwalla","Climbing Mouse","Coati","Cobra","Cotton Rat","Cougar","Courser","Crane Fly","Crow","Dassie Rat","Dove","Dunnart","Eagle","Echidna","Elephant","Emu","Falcon","Fly","Fox","Frogmouth","Gecko","Geoffroy's Cat","Gerbil","Grasshopper","Guanaco","Gundi","Hamster","Hawk","Hedgehog","Hyena","Hyrax","Jackal","Kangaroo","Kangaroo Rat","Kestrel","Kowari","Kultarr","Leopard","Lion","Macaw","Meerkat","Mouse","Oryx","Ostrich","Owl","Pronghorn","Python","Rabbit","Raccoon","Rattlesnake","Rhinoceros","Sand Cat","Spectacled Bear","Spiny Mouse","Starling","Stick Bug","Tarantula","Tit","Toad","Tortoise","Tyrant Flycatcher","Viper","Vulture","Waxwing","Xerus","Zebra"], - "grassland" : ["Aardvark","Aardwolf","Accentor","African Buffalo","African Wild Dog","Alpaca","Anaconda","Ant","Anteater","Antelope","Armadillo","Baboon","Badger","Bandicoot","Barbet","Bat","Bee","Bee-eater","Beetle","Bird","Bison","Black-footed Cat","Black-footed Ferret","Bluebird","Boa","Bowerbird","Brown Bear","Bush Dog","Bushshrike","Bustard","Butterfly","Buzzard","Caracal","Caracara","Cardinal","Caterpillar","Cheetah","Chipmunk","Civet","Climbing Mouse","Clouded Leopard","Coati","Cobra","Cockatoo","Cockroach","Common Genet","Cotton Rat","Cougar","Courser","Coyote","Crane","Crane Fly","Cricket","Crow","Culpeo","Death Adder","Deer","Deer Mouse","Dingo","Dinosaur","Dove","Drongo","Duck","Duiker","Dunnart","Eagle","Echidna","Elephant","Elk","Emu","Falcon","Finch","Flea","Fly","Flying Frog","Fox","Frog","Frogmouth","Garter Snake","Gazelle","Gecko","Geoffroy's Cat","Gerbil","Giant Tortoise","Giraffe","Grasshopper","Grison","Groundhog","Grouse","Guanaco","Guinea Pig","Hamster","Harrier","Hartebeest","Hawk","Hedgehog","Helmetshrike","Hippopotamus","Hornbill","Hyena","Hyrax","Impala","Jackal","Jaguar","Jaguarundi","Kangaroo","Kangaroo Rat","Kestrel","Kultarr","Ladybug","Leopard","Lion","Macaw","Meerkat","Mouse","Newt","Oryx","Ostrich","Owl","Pangolin","Pheasant","Prairie Dog","Pronghorn","Przewalski's Horse","Python","Quoll","Rabbit","Raven","Rhinoceros","Shelduck","Sloth Bear","Spectacled Bear","Squirrel","Starling","Stick Bug","Tamandua","Tasmanian Devil","Thornbill","Thrush","Toad","Tortoise"], - "forest" : ["Agouti","Anaconda","Anoa","Ant","Anteater","Antelope","Armadillo","Asian Black Bear","Aye-aye","Babirusa","Baboon","Badger","Bandicoot","Banteng","Barbet","Basilisk","Bat","Bearded Dragon","Bee","Bee-eater","Beetle","Bettong","Binturong","Bird-of-paradise","Bongo","Bowerbird","Bulbul","Bush Dog","Bushbaby","Bushshrike","Butterfly","Buzzard","Caecilian","Cardinal","Cassowary","Caterpillar","Centipede","Chameleon","Chimpanzee","Cicada","Civet","Clouded Leopard","Coati","Cobra","Cockatoo","Cockroach","Colugo","Cotinga","Cotton Rat","Cougar","Crane Fly","Cricket","Crocodile","Crow","Cuckoo","Cuscus","Death Adder","Deer","Dhole","Dingo","Dinosaur","Drongo","Duck","Duiker","Eagle","Echidna","Elephant","Finch","Flat-headed Cat","Flea","Flowerpecker","Fly","Flying Frog","Fossa","Frog","Frogmouth","Gaur","Gecko","Gorilla","Grison","Hawaiian Honeycreeper","Hawk","Hedgehog","Helmetshrike","Hornbill","Hyrax","Iguana","Jackal","Jaguar","Jaguarundi","Kestrel","Ladybug","Lemur","Leopard","Lion","Macaw","Mandrill","Margay","Monkey","Mouse","Mouse Deer","Newt","Okapi","Old World Flycatcher","Orangutan","Owl","Pangolin","Peafowl","Pheasant","Possum","Python","Quokka","Rabbit","Raccoon","Red Panda","Red River Hog","Rhinoceros","Sloth Bear","Spectacled Bear","Squirrel","Starling","Stick Bug","Sun Bear","Tamandua","Tamarin","Tapir","Tarantula","Thrush","Tiger","Tit","Toad","Tortoise","Toucan","Trogon","Trumpeter","Turaco","Turtle","Tyrant Flycatcher","Viper","Vulture","Wallaby","Warbler","Wasp","Waxwing","Weaver","Weaver-finch","Whistler","White-eye","Whydah","Woodswallow","Worm","Wren","Xenops","Yellowjacket","Accentor","African Buffalo","American Black Bear","Anole","Bird","Bison","Boa","Brown Bear","Chipmunk","Common Genet","Copperhead","Coyote","Deer Mouse","Dormouse","Elk","Emu","Fisher","Fox","Garter Snake","Giant Panda","Giant Tortoise","Groundhog","Grouse","Guanaco","Himalayan Tahr","Kangaroo","Koala","Numbat","Quoll","Raccoon dog","Tasmanian Devil","Thornbill","Turkey","Vole","Weasel","Wildcat","Wolf","Wombat","Woodchuck","Woodpecker"], - "farm" : ["Alpaca","Buffalo","Banteng","Cow","Cat","Chicken","Carp","Camel","Donkey","Dog","Duck","Emu","Goat","Gayal","Guinea","Goose","Horse","Honey","Llama","Pig","Pigeon","Rhea","Rabbit","Sheep","Silkworm","Turkey","Yak","Zebu"], - "pet" : ["Bearded Dragon","Birds","Burro","Cats","Chameleons","Chickens","Chinchillas","Chinese Water Dragon","Cows","Dogs","Donkey","Ducks","Ferrets","Fish","Geckos","Geese","Gerbils","Goats","Guinea Fowl","Guinea Pigs","Hamsters","Hedgehogs","Horses","Iguanas","Llamas","Lizards","Mice","Mule","Peafowl","Pigs and Hogs","Pigeons","Ponies","Pot Bellied Pig","Rabbits","Rats","Sheep","Skinks","Snakes","Stick Insects","Sugar Gliders","Tarantula","Turkeys","Turtles"], - "zoo" : ["Aardvark","African Wild Dog","Aldabra Tortoise","American Alligator","American Bison","Amur Tiger","Anaconda","Andean Condor","Asian Elephant","Baby Doll Sheep","Bald Eagle","Barred Owl","Blue Iguana","Boer Goat","California Sea Lion","Caribbean Flamingo","Chinchilla","Collared Lemur","Coquerel's Sifaka","Cuban Amazon Parrot","Ebony Langur","Fennec Fox","Fossa","Gelada","Giant Anteater","Giraffe","Gorilla","Grizzly Bear","Henkel's Leaf-tailed Gecko","Indian Gharial","Indian Rhinoceros","King Cobra","King Vulture","Komodo Dragon","Linne's Two-toed Sloth","Lion","Little Penguin","Madagascar Tree Boa","Magellanic Penguin","Malayan Tapir","Malayan Tiger","Matschies Tree Kangaroo","Mini Donkey","Monarch Butterfly","Nile crocodile","North American Porcupine","Nubian Ibex","Okapi","Poison Dart Frog","Polar Bear","Pygmy Marmoset","Radiated Tortoise","Red Panda","Red Ruffed Lemur","Ring-tailed Lemur","Ring-tailed Mongoose","Rock Hyrax","Small Clawed Asian Otter","Snow Leopard","Snowy Owl","Southern White-faced Owl","Southern White Rhinocerous","Squirrel Monkey","Tufted Puffin","White Cheeked Gibbon","White-throated Bee Eater","Zebra"] - } + const animals = { + en_US: { + ocean: ['Acantharea', 'Anemone', 'Angelfish King', 'Ahi Tuna', 'Albacore', 'American Oyster', 'Anchovy', 'Armored Snail', 'Arctic Char', 'Atlantic Bluefin Tuna', 'Atlantic Cod', 'Atlantic Goliath Grouper', 'Atlantic Trumpetfish', 'Atlantic Wolffish', 'Baleen Whale', 'Banded Butterflyfish', 'Banded Coral Shrimp', 'Banded Sea Krait', 'Barnacle', 'Barndoor Skate', 'Barracuda', 'Basking Shark', 'Bass', 'Beluga Whale', 'Bluebanded Goby', 'Bluehead Wrasse', 'Bluefish', 'Bluestreak Cleaner-Wrasse', 'Blue Marlin', 'Blue Shark', 'Blue Spiny Lobster', 'Blue Tang', 'Blue Whale', 'Broadclub Cuttlefish', 'Bull Shark', 'Chambered Nautilus', 'Chilean Basket Star', 'Chilean Jack Mackerel', 'Chinook Salmon', 'Christmas Tree Worm', 'Clam', 'Clown Anemonefish', 'Clown Triggerfish', 'Cod', 'Coelacanth', 'Cockscomb Cup Coral', 'Common Fangtooth', 'Conch', 'Cookiecutter Shark', 'Copepod', 'Coral', 'Corydoras', 'Cownose Ray', 'Crab', 'Crown-of-Thorns Starfish', 'Cushion Star', 'Cuttlefish', 'California Sea Otters', 'Dolphin', 'Dolphinfish', 'Dory', 'Devil Fish', 'Dugong', 'Dumbo Octopus', 'Dungeness Crab', 'Eccentric Sand Dollar', 'Edible Sea Cucumber', 'Eel', 'Elephant Seal', 'Elkhorn Coral', 'Emperor Shrimp', 'Estuarine Crocodile', 'Fathead Sculpin', 'Fiddler Crab', 'Fin Whale', 'Flameback', 'Flamingo Tongue Snail', 'Flashlight Fish', 'Flatback Turtle', 'Flatfish', 'Flying Fish', 'Flounder', 'Fluke', 'French Angelfish', 'Frilled Shark', 'Fugu (also called Pufferfish)', 'Gar', 'Geoduck', 'Giant Barrel Sponge', 'Giant Caribbean Sea Anemone', 'Giant Clam', 'Giant Isopod', 'Giant Kingfish', 'Giant Oarfish', 'Giant Pacific Octopus', 'Giant Pyrosome', 'Giant Sea Star', 'Giant Squid', 'Glowing Sucker Octopus', 'Giant Tube Worm', 'Goblin Shark', 'Goosefish', 'Great White Shark', 'Greenland Shark', 'Grey Atlantic Seal', 'Grouper', 'Grunion', 'Guineafowl Puffer', 'Haddock', 'Hake', 'Halibut', 'Hammerhead Shark', 'Hapuka', 'Harbor Porpoise', 'Harbor Seal', 'Hatchetfish', 'Hawaiian Monk Seal', 'Hawksbill Turtle', 'Hector\'s Dolphin', 'Hermit Crab', 'Herring', 'Hoki', 'Horn Shark', 'Horseshoe Crab', 'Humpback Anglerfish', 'Humpback Whale', 'Icefish', 'Imperator Angelfish', 'Irukandji Jellyfish', 'Isopod', 'Ivory Bush Coral', 'Japanese Spider Crab', 'Jellyfish', 'John Dory', 'Juan Fernandez Fur Seal', 'Killer Whale', 'Kiwa Hirsuta', 'Krill', 'Lagoon Triggerfish', 'Lamprey', 'Leafy Seadragon', 'Leopard Seal', 'Limpet', 'Ling', 'Lionfish', 'Lions Mane Jellyfish', 'Lobe Coral', 'Lobster', 'Loggerhead Turtle', 'Longnose Sawshark', 'Longsnout Seahorse', 'Lophelia Coral', 'Marrus Orthocanna', 'Manatee', 'Manta Ray', 'Marlin', 'Megamouth Shark', 'Mexican Lookdown', 'Mimic Octopus', 'Moon Jelly', 'Mollusk', 'Monkfish', 'Moray Eel', 'Mullet', 'Mussel', 'Megaladon', 'Napoleon Wrasse', 'Nassau Grouper', 'Narwhal', 'Nautilus', 'Needlefish', 'Northern Seahorse', 'North Atlantic Right Whale', 'Northern Red Snapper', 'Norway Lobster', 'Nudibranch', 'Nurse Shark', 'Oarfish', 'Ocean Sunfish', 'Oceanic Whitetip Shark', 'Octopus', 'Olive Sea Snake', 'Orange Roughy', 'Ostracod', 'Otter', 'Oyster', 'Pacific Angelshark', 'Pacific Blackdragon', 'Pacific Halibut', 'Pacific Sardine', 'Pacific Sea Nettle Jellyfish', 'Pacific White Sided Dolphin', 'Pantropical Spotted Dolphin', 'Patagonian Toothfish', 'Peacock Mantis Shrimp', 'Pelagic Thresher Shark', 'Penguin', 'Peruvian Anchoveta', 'Pilchard', 'Pink Salmon', 'Pinniped', 'Plankton', 'Porpoise', 'Polar Bear', 'Portuguese Man o\' War', 'Pycnogonid Sea Spider', 'Quahog', 'Queen Angelfish', 'Queen Conch', 'Queen Parrotfish', 'Queensland Grouper', 'Ragfish', 'Ratfish', 'Rattail Fish', 'Ray', 'Red Drum', 'Red King Crab', 'Ringed Seal', 'Risso\'s Dolphin', 'Ross Seals', 'Sablefish', 'Salmon', 'Sand Dollar', 'Sandbar Shark', 'Sawfish', 'Sarcastic Fringehead', 'Scalloped Hammerhead Shark', 'Seahorse', 'Sea Cucumber', 'Sea Lion', 'Sea Urchin', 'Seal', 'Shark', 'Shortfin Mako Shark', 'Shovelnose Guitarfish', 'Shrimp', 'Silverside Fish', 'Skipjack Tuna', 'Slender Snipe Eel', 'Smalltooth Sawfish', 'Smelts', 'Sockeye Salmon', 'Southern Stingray', 'Sponge', 'Spotted Porcupinefish', 'Spotted Dolphin', 'Spotted Eagle Ray', 'Spotted Moray', 'Squid', 'Squidworm', 'Starfish', 'Stickleback', 'Stonefish', 'Stoplight Loosejaw', 'Sturgeon', 'Swordfish', 'Tan Bristlemouth', 'Tasseled Wobbegong', 'Terrible Claw Lobster', 'Threespot Damselfish', 'Tiger Prawn', 'Tiger Shark', 'Tilefish', 'Toadfish', 'Tropical Two-Wing Flyfish', 'Tuna', 'Umbrella Squid', 'Velvet Crab', 'Venus Flytrap Sea Anemone', 'Vigtorniella Worm', 'Viperfish', 'Vampire Squid', 'Vaquita', 'Wahoo', 'Walrus', 'West Indian Manatee', 'Whale', 'Whale Shark', 'Whiptail Gulper', 'White-Beaked Dolphin', 'White-Ring Garden Eel', 'White Shrimp', 'Wobbegong', 'Wrasse', 'Wreckfish', 'Xiphosura', 'Yellowtail Damselfish', 'Yelloweye Rockfish', 'Yellow Cup Black Coral', 'Yellow Tube Sponge', 'Yellowfin Tuna', 'Zebrashark', 'Zooplankton'], + desert: ['Aardwolf', 'Addax', 'African Wild Ass', 'Ant', 'Antelope', 'Armadillo', 'Baboon', 'Badger', 'Bat', 'Bearded Dragon', 'Beetle', 'Bird', 'Black-footed Cat', 'Boa', 'Brown Bear', 'Bustard', 'Butterfly', 'Camel', 'Caracal', 'Caracara', 'Caterpillar', 'Centipede', 'Cheetah', 'Chipmunk', 'Chuckwalla', 'Climbing Mouse', 'Coati', 'Cobra', 'Cotton Rat', 'Cougar', 'Courser', 'Crane Fly', 'Crow', 'Dassie Rat', 'Dove', 'Dunnart', 'Eagle', 'Echidna', 'Elephant', 'Emu', 'Falcon', 'Fly', 'Fox', 'Frogmouth', 'Gecko', 'Geoffroy\'s Cat', 'Gerbil', 'Grasshopper', 'Guanaco', 'Gundi', 'Hamster', 'Hawk', 'Hedgehog', 'Hyena', 'Hyrax', 'Jackal', 'Kangaroo', 'Kangaroo Rat', 'Kestrel', 'Kowari', 'Kultarr', 'Leopard', 'Lion', 'Macaw', 'Meerkat', 'Mouse', 'Oryx', 'Ostrich', 'Owl', 'Pronghorn', 'Python', 'Rabbit', 'Raccoon', 'Rattlesnake', 'Rhinoceros', 'Sand Cat', 'Spectacled Bear', 'Spiny Mouse', 'Starling', 'Stick Bug', 'Tarantula', 'Tit', 'Toad', 'Tortoise', 'Tyrant Flycatcher', 'Viper', 'Vulture', 'Waxwing', 'Xerus', 'Zebra'], + grassland: ['Aardvark', 'Aardwolf', 'Accentor', 'African Buffalo', 'African Wild Dog', 'Alpaca', 'Anaconda', 'Ant', 'Anteater', 'Antelope', 'Armadillo', 'Baboon', 'Badger', 'Bandicoot', 'Barbet', 'Bat', 'Bee', 'Bee-eater', 'Beetle', 'Bird', 'Bison', 'Black-footed Cat', 'Black-footed Ferret', 'Bluebird', 'Boa', 'Bowerbird', 'Brown Bear', 'Bush Dog', 'Bushshrike', 'Bustard', 'Butterfly', 'Buzzard', 'Caracal', 'Caracara', 'Cardinal', 'Caterpillar', 'Cheetah', 'Chipmunk', 'Civet', 'Climbing Mouse', 'Clouded Leopard', 'Coati', 'Cobra', 'Cockatoo', 'Cockroach', 'Common Genet', 'Cotton Rat', 'Cougar', 'Courser', 'Coyote', 'Crane', 'Crane Fly', 'Cricket', 'Crow', 'Culpeo', 'Death Adder', 'Deer', 'Deer Mouse', 'Dingo', 'Dinosaur', 'Dove', 'Drongo', 'Duck', 'Duiker', 'Dunnart', 'Eagle', 'Echidna', 'Elephant', 'Elk', 'Emu', 'Falcon', 'Finch', 'Flea', 'Fly', 'Flying Frog', 'Fox', 'Frog', 'Frogmouth', 'Garter Snake', 'Gazelle', 'Gecko', 'Geoffroy\'s Cat', 'Gerbil', 'Giant Tortoise', 'Giraffe', 'Grasshopper', 'Grison', 'Groundhog', 'Grouse', 'Guanaco', 'Guinea Pig', 'Hamster', 'Harrier', 'Hartebeest', 'Hawk', 'Hedgehog', 'Helmetshrike', 'Hippopotamus', 'Hornbill', 'Hyena', 'Hyrax', 'Impala', 'Jackal', 'Jaguar', 'Jaguarundi', 'Kangaroo', 'Kangaroo Rat', 'Kestrel', 'Kultarr', 'Ladybug', 'Leopard', 'Lion', 'Macaw', 'Meerkat', 'Mouse', 'Newt', 'Oryx', 'Ostrich', 'Owl', 'Pangolin', 'Pheasant', 'Prairie Dog', 'Pronghorn', 'Przewalski\'s Horse', 'Python', 'Quoll', 'Rabbit', 'Raven', 'Rhinoceros', 'Shelduck', 'Sloth Bear', 'Spectacled Bear', 'Squirrel', 'Starling', 'Stick Bug', 'Tamandua', 'Tasmanian Devil', 'Thornbill', 'Thrush', 'Toad', 'Tortoise'], + forest: ['Agouti', 'Anaconda', 'Anoa', 'Ant', 'Anteater', 'Antelope', 'Armadillo', 'Asian Black Bear', 'Aye-aye', 'Babirusa', 'Baboon', 'Badger', 'Bandicoot', 'Banteng', 'Barbet', 'Basilisk', 'Bat', 'Bearded Dragon', 'Bee', 'Bee-eater', 'Beetle', 'Bettong', 'Binturong', 'Bird-of-paradise', 'Bongo', 'Bowerbird', 'Bulbul', 'Bush Dog', 'Bushbaby', 'Bushshrike', 'Butterfly', 'Buzzard', 'Caecilian', 'Cardinal', 'Cassowary', 'Caterpillar', 'Centipede', 'Chameleon', 'Chimpanzee', 'Cicada', 'Civet', 'Clouded Leopard', 'Coati', 'Cobra', 'Cockatoo', 'Cockroach', 'Colugo', 'Cotinga', 'Cotton Rat', 'Cougar', 'Crane Fly', 'Cricket', 'Crocodile', 'Crow', 'Cuckoo', 'Cuscus', 'Death Adder', 'Deer', 'Dhole', 'Dingo', 'Dinosaur', 'Drongo', 'Duck', 'Duiker', 'Eagle', 'Echidna', 'Elephant', 'Finch', 'Flat-headed Cat', 'Flea', 'Flowerpecker', 'Fly', 'Flying Frog', 'Fossa', 'Frog', 'Frogmouth', 'Gaur', 'Gecko', 'Gorilla', 'Grison', 'Hawaiian Honeycreeper', 'Hawk', 'Hedgehog', 'Helmetshrike', 'Hornbill', 'Hyrax', 'Iguana', 'Jackal', 'Jaguar', 'Jaguarundi', 'Kestrel', 'Ladybug', 'Lemur', 'Leopard', 'Lion', 'Macaw', 'Mandrill', 'Margay', 'Monkey', 'Mouse', 'Mouse Deer', 'Newt', 'Okapi', 'Old World Flycatcher', 'Orangutan', 'Owl', 'Pangolin', 'Peafowl', 'Pheasant', 'Possum', 'Python', 'Quokka', 'Rabbit', 'Raccoon', 'Red Panda', 'Red River Hog', 'Rhinoceros', 'Sloth Bear', 'Spectacled Bear', 'Squirrel', 'Starling', 'Stick Bug', 'Sun Bear', 'Tamandua', 'Tamarin', 'Tapir', 'Tarantula', 'Thrush', 'Tiger', 'Tit', 'Toad', 'Tortoise', 'Toucan', 'Trogon', 'Trumpeter', 'Turaco', 'Turtle', 'Tyrant Flycatcher', 'Viper', 'Vulture', 'Wallaby', 'Warbler', 'Wasp', 'Waxwing', 'Weaver', 'Weaver-finch', 'Whistler', 'White-eye', 'Whydah', 'Woodswallow', 'Worm', 'Wren', 'Xenops', 'Yellowjacket', 'Accentor', 'African Buffalo', 'American Black Bear', 'Anole', 'Bird', 'Bison', 'Boa', 'Brown Bear', 'Chipmunk', 'Common Genet', 'Copperhead', 'Coyote', 'Deer Mouse', 'Dormouse', 'Elk', 'Emu', 'Fisher', 'Fox', 'Garter Snake', 'Giant Panda', 'Giant Tortoise', 'Groundhog', 'Grouse', 'Guanaco', 'Himalayan Tahr', 'Kangaroo', 'Koala', 'Numbat', 'Quoll', 'Raccoon dog', 'Tasmanian Devil', 'Thornbill', 'Turkey', 'Vole', 'Weasel', 'Wildcat', 'Wolf', 'Wombat', 'Woodchuck', 'Woodpecker'], + farm: ['Alpaca', 'Buffalo', 'Banteng', 'Cow', 'Cat', 'Chicken', 'Carp', 'Camel', 'Donkey', 'Dog', 'Duck', 'Emu', 'Goat', 'Gayal', 'Guinea', 'Goose', 'Horse', 'Honey', 'Llama', 'Pig', 'Pigeon', 'Rhea', 'Rabbit', 'Sheep', 'Silkworm', 'Turkey', 'Yak', 'Zebu'], + pet: ['Bearded Dragon', 'Birds', 'Burro', 'Cats', 'Chameleons', 'Chickens', 'Chinchillas', 'Chinese Water Dragon', 'Cows', 'Dogs', 'Donkey', 'Ducks', 'Ferrets', 'Fish', 'Geckos', 'Geese', 'Gerbils', 'Goats', 'Guinea Fowl', 'Guinea Pigs', 'Hamsters', 'Hedgehogs', 'Horses', 'Iguanas', 'Llamas', 'Lizards', 'Mice', 'Mule', 'Peafowl', 'Pigs and Hogs', 'Pigeons', 'Ponies', 'Pot Bellied Pig', 'Rabbits', 'Rats', 'Sheep', 'Skinks', 'Snakes', 'Stick Insects', 'Sugar Gliders', 'Tarantula', 'Turkeys', 'Turtles'], + zoo: ['Aardvark', 'African Wild Dog', 'Aldabra Tortoise', 'American Alligator', 'American Bison', 'Amur Tiger', 'Anaconda', 'Andean Condor', 'Asian Elephant', 'Baby Doll Sheep', 'Bald Eagle', 'Barred Owl', 'Blue Iguana', 'Boer Goat', 'California Sea Lion', 'Caribbean Flamingo', 'Chinchilla', 'Collared Lemur', 'Coquerel\'s Sifaka', 'Cuban Amazon Parrot', 'Ebony Langur', 'Fennec Fox', 'Fossa', 'Gelada', 'Giant Anteater', 'Giraffe', 'Gorilla', 'Grizzly Bear', 'Henkel\'s Leaf-tailed Gecko', 'Indian Gharial', 'Indian Rhinoceros', 'King Cobra', 'King Vulture', 'Komodo Dragon', 'Linne\'s Two-toed Sloth', 'Lion', 'Little Penguin', 'Madagascar Tree Boa', 'Magellanic Penguin', 'Malayan Tapir', 'Malayan Tiger', 'Matschies Tree Kangaroo', 'Mini Donkey', 'Monarch Butterfly', 'Nile crocodile', 'North American Porcupine', 'Nubian Ibex', 'Okapi', 'Poison Dart Frog', 'Polar Bear', 'Pygmy Marmoset', 'Radiated Tortoise', 'Red Panda', 'Red Ruffed Lemur', 'Ring-tailed Lemur', 'Ring-tailed Mongoose', 'Rock Hyrax', 'Small Clawed Asian Otter', 'Snow Leopard', 'Snowy Owl', 'Southern White-faced Owl', 'Southern White Rhinocerous', 'Squirrel Monkey', 'Tufted Puffin', 'White Cheeked Gibbon', 'White-throated Bee Eater', 'Zebra'], + }, }; - let locale = options.locale || 'en_US'; - let type = options.type || 'zoo'; + const locale = options.locale || 'en_US'; + const type = options.type || 'zoo'; return animals[locale][type][Math.floor(Math.random() * animals[locale][type].length)]; -}; \ No newline at end of file +} diff --git a/index.test-d.ts b/index.test-d.ts new file mode 100644 index 0000000..ddfda23 --- /dev/null +++ b/index.test-d.ts @@ -0,0 +1,7 @@ +import {expectType} from 'tsd'; +import animal from './index.js'; + +expectType(animal()); +expectType(animal({type: 'zoo'})); +expectType(animal({locale: 'en_US'})); +expectType(animal({type: 'zoo', locale: 'en_US'})); diff --git a/package.json b/package.json index fc7efff..b88329e 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@fakerjs/animal", - "version": "2.0.1", + "version": "2.1.0", "description": "Animal package provides functionality to generate a fake animal value.", "license": "MIT", "repository": "faker-javascript/animal", @@ -15,14 +15,17 @@ "node": ">=12" }, "scripts": { - "test": "c8 ava" + "test": "c8 ava; xo --space 4; tsd;" }, "devDependencies": { - "ava": "^3.15.0", - "c8": "^7.11.0" + "ava": "^4.0.0", + "c8": "^7.11.0", + "tsd": "^0.19.1", + "xo": "^0.47.0" }, "files": [ - "index.js" + "index.js", + "index.d.ts" ], "keywords": [ "fakerjs", diff --git a/test.js b/test.js index 3f4fa6b..136002b 100644 --- a/test.js +++ b/test.js @@ -1,10 +1,10 @@ -import animal from './index.js'; import test from 'ava'; +import animal from './index.js'; test('animal return type to be string', t => { - t.is(typeof animal(), 'string'); + t.is(typeof animal(), 'string'); }); test('animal with type and locale return type to be string', t => { - t.is(typeof animal({type: 'zoo', locale: 'en_US'}), 'string'); -}); \ No newline at end of file + t.is(typeof animal({type: 'zoo', locale: 'en_US'}), 'string'); +});