getLength.lua 475 B

123456789101112131415161718192021222324
  1. return {
  2. tag = 'buffer-metadata',
  3. summary = 'Get the length of the Buffer.',
  4. description = [[
  5. Returns the length of the Buffer, or `nil` if the Buffer was not created with a format.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. length = {
  10. type = 'number',
  11. description = 'The length of the Buffer.'
  12. }
  13. },
  14. variants = {
  15. {
  16. arguments = {},
  17. returns = { 'length' }
  18. }
  19. },
  20. related = {
  21. 'Buffer:getSize',
  22. 'Buffer:getStride'
  23. }
  24. }