codenamer.luau/examples/tostring.luau

--[[
    examples/tostring.luau

    Description: Codenamer implements a custom tostring metamethod, which returns a "generic type"
                 based on the state of the codenamer instance.
]]--

local Codenamer = require("../dist/codenamer")

local codenamer = Codenamer.new()

print("I have a codenamer instance of type:", tostring(codenamer))

codenamer:with_dictionary({ "this", "is", "a", "custom", "dictionary" })

print("With a custom dictionary provided, the instance is now of type: ", tostring(codenamer))
chore(examples): include example descriptions 2023-08-19 16:23:34 +01:00			`--[[`
			`examples/tostring.luau`

			`Description: Codenamer implements a custom tostring metamethod, which returns a "generic type"`
			`based on the state of the codenamer instance.`
			`]]--`

chore(examples): include tostring example 2023-08-19 16:19:10 +01:00			`local Codenamer = require("../dist/codenamer")`

			`local codenamer = Codenamer.new()`

			`print("I have a codenamer instance of type:", tostring(codenamer))`

			`codenamer:with_dictionary({ "this", "is", "a", "custom", "dictionary" })`

			`print("With a custom dictionary provided, the instance is now of type: ", tostring(codenamer))`